configure-s3-website 1.4.0 → 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57823af5f276b1d5990767f66c1d091c7e3aab2f
+  data.tar.gz: 7b5328afc20f3d96a0c8519be1a7d1d984cd8e64
+SHA512:
+  metadata.gz: 267418558c77dc6705503ed76a8dfee2367918793ce82efcdd6963bba5e9958b36725927cabf0628b8a34bfa3387049bf472ca09a1dc07c743724d7ceba666c9
+  data.tar.gz: c12bcb19386baf65c246833154046a6b56534a96cccb2cf907b89421654cfabe9c93c7228bf7b367d3af8f2eab4e49b4990fe17c63d861421bcd5151de4ecc53

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-- 1.9.2
 - 1.9.3
 - 2.0.0

data/README.md

@@ -9,6 +9,8 @@ command-line interface.
 The bucket may or may not exist. If the bucket does not exist,
 `configure-s3-website` will create it.
 
+For deploying websites to S3, consider using [s3_website](https://github.com/laurilehmijoki/s3_website).
+
 ## Install
 
     gem install configure-s3-website
@@ -69,7 +71,10 @@ file. For example:
 cloudfront_distribution_config:
   default_cache_behavior:
     min_TTL: 600
-  default_root_object: index.json
+  aliases:
+    quantity: 1
+    items:
+      CNAME: your.domain.net
 ```
 
 See the section below for more information about the valid values of the
@@ -168,6 +173,19 @@ configuration file a row like this:
 The valid *s3_endpoint* values consist of the [S3 location constraint
 values](http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region).
 
+
+### Specifying non-standard index or error documents
+
+By default, `configure-s3-website` uses `index.html` for the index document and `error.html` for the error document.
+
+You can override either or both of these defaults like this:
+
+    index_document: default.html
+    error_document: 404.html
+
+You can specify the name of any document in the bucket.
+
+
 ### Configuring redirects
 
 You can configure redirects on your S3 website by adding `routing_rules` into
@@ -223,10 +241,13 @@ Big thanks to the following contributors (in alphabetical order):
 
 * SlawD
 * Steve Schwartz
+* Toby Marsden
 
 ## Supported Ruby versions
 
-The file `.travis.yml` defines the supported Ruby versions.
+The file `.travis.yml` defines the officially supported Ruby versions. This gem
+might work on other versions as well, but they are not covered with continuous
+integration.
 
 ## License
 

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 1.5.0
+
+* Add support for custom index and error documents
+
 ## 1.4.0
 
 * Allow the user to store his CloudFront settings in the config file

data/configure-s3-website.gemspec

@@ -18,6 +18,7 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 0.9.0'
   s.add_development_dependency 'vcr', '~> 2.3.0'
   s.add_development_dependency 'webmock', '~> 1.8.0'
+  s.add_development_dependency 'json', '~> 1.7.7'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/configure-s3-website/config_source/file_config_source.rb

@@ -32,6 +32,14 @@ module ConfigureS3Website
       @config['routing_rules']
     end
 
+    def index_document
+      @config['index_document']
+    end
+
+    def error_document
+      @config['error_document']
+    end
+
     def cloudfront_distribution_config
       @config['cloudfront_distribution_config']
     end

data/lib/configure-s3-website/s3_client.rb

@@ -24,10 +24,10 @@ module ConfigureS3Website
       body = %|
         <WebsiteConfiguration xmlns='http://s3.amazonaws.com/doc/2006-03-01/'>
           <IndexDocument>
-            <Suffix>index.html</Suffix>
+            <Suffix>#{config_source.index_document || "index.html"}</Suffix>
           </IndexDocument>
           <ErrorDocument>
-            <Key>error.html</Key>
+            <Key>#{config_source.error_document || "error.html"}</Key>
           </ErrorDocument>
         </WebsiteConfiguration>
       |
@@ -66,10 +66,10 @@ module ConfigureS3Website
         body = %|
           <WebsiteConfiguration xmlns='http://s3.amazonaws.com/doc/2006-03-01/'>
             <IndexDocument>
-              <Suffix>index.html</Suffix>
+              <Suffix>#{config_source.index_document || "index.html"}</Suffix>
             </IndexDocument>
             <ErrorDocument>
-              <Key>error.html</Key>
+              <Key>#{config_source.error_document || "error.html"}</Key>
             </ErrorDocument>
             <RoutingRules>
         |

data/lib/configure-s3-website/version.rb

@@ -1,3 +1,3 @@
 module ConfigureS3Website
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/spec/s3_client_spec.rb

@@ -2,51 +2,116 @@ require 'rspec'
 require 'configure-s3-website'
 
 describe ConfigureS3Website::S3Client do
-  context '#create_bucket with invalid s3_endpoint value' do
-    let(:config_source) {
-      mock = double('config_source')
-      mock.stub(:s3_endpoint).and_return('invalid-location-constraint')
-      mock
-    }
-
-    it 'throws an error' do
-      expect {
-        extractor = ConfigureS3Website::S3Client.
-          send(:create_bucket, config_source)
-      }.to raise_error(InvalidS3LocationConstraintError)
+  describe '#enable_website_configuration' do
+    context 'custom index and error documents' do
+      let(:config_source) {
+        ConfigureS3Website::FileConfigSource.new('spec/sample_files/_custom_index_and_error_docs.yml')
+      }
+
+      it 'calls the S3 API with the custom index document' do
+        expect_api_call(
+          :enable_website_configuration,
+          /<IndexDocument>\s*<Suffix>default.html<\/Suffix>\s*<\/IndexDocument>/,
+          config_source
+        )
+      end
+
+      it 'calls the S3 API with the custom error document' do
+        expect_api_call(
+          :enable_website_configuration,
+          /<ErrorDocument>\s*<Key>404.html<\/Key>\s*<\/ErrorDocument>/,
+          config_source
+        )
+      end
     end
   end
 
-  context '#create_bucket with no s3_endpoint value' do
-    let(:config_source) {
-      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file.yml')
-    }
+  describe '#configure_bucket_redirects' do
+    context 'custom index and error documents' do
+      let(:config_source) {
+        ConfigureS3Website::FileConfigSource.new('spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml')
+      }
+
+      it 'calls the S3 API with the custom index document' do
+        expect_api_call(
+          :configure_bucket_redirects,
+          /<IndexDocument>\s*<Suffix>default.html<\/Suffix>\s*<\/IndexDocument>/,
+          config_source
+        )
+      end
 
-    it 'calls the S3 api without request body' do
-      ConfigureS3Website::HttpHelper.should_receive(:call_s3_api).
-        with(anything(), anything(), '', anything())
-      ConfigureS3Website::S3Client.send(:create_bucket,
-                                        config_source)
+      it 'calls the S3 API with the custom error document' do
+        expect_api_call(
+          :configure_bucket_redirects,
+          /<ErrorDocument>\s*<Key>missing.html<\/Key>\s*<\/ErrorDocument>/,
+          config_source
+        )
+      end
     end
   end
 
-  context '#create_bucket with s3_endpoint value' do
-    let(:config_source) {
-      ConfigureS3Website::FileConfigSource.new(
-        'spec/sample_files/_config_file_oregon.yml'
+  describe '#create_bucket' do
+    context 'invalid s3_endpoint value' do
+      let(:config_source) {
+        mock = double('config_source')
+        mock.stub(:s3_endpoint).and_return('invalid-location-constraint')
+        mock
+      }
+
+      it 'throws an error' do
+        expect {
+          extractor = ConfigureS3Website::S3Client.
+          send(:create_bucket, config_source)
+        }.to raise_error(InvalidS3LocationConstraintError)
+      end
+    end
+
+    context 'no s3_endpoint value' do
+      let(:config_source) {
+        ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file.yml')
+      }
+
+      it 'calls the S3 api without request body' do
+        ConfigureS3Website::HttpHelper.should_receive(:call_s3_api).
+          with(anything(), anything(), '', anything())
+        ConfigureS3Website::S3Client.send(:create_bucket,
+                                          config_source)
+      end
+    end
+
+    context 'valid s3_endpoint value' do
+      let(:config_source) {
+        ConfigureS3Website::FileConfigSource.new(
+          'spec/sample_files/_config_file_oregon.yml'
       )
-    }
+      }
 
-    it 'calls the S3 api with location constraint XML' do
-      ConfigureS3Website::HttpHelper.should_receive(:call_s3_api).
-        with(anything(), anything(),
+      it 'calls the S3 api with location constraint XML' do
+        ConfigureS3Website::HttpHelper.should_receive(:call_s3_api).
+          with(anything(), anything(),
         %|
           <CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
             <LocationConstraint>us-west-2</LocationConstraint>
           </CreateBucketConfiguration >
          |, anything())
-      ConfigureS3Website::S3Client.send(:create_bucket,
-                                        config_source)
+        ConfigureS3Website::S3Client.send(:create_bucket,
+                                          config_source)
+      end
     end
   end
+
+  def expect_api_call(operation, body, config_source)
+    ConfigureS3Website::HttpHelper.
+      should_receive(:call_s3_api).
+      with(
+        anything(),
+        anything(),
+        body,
+        anything()
+    )
+    ConfigureS3Website::S3Client.send(
+      operation,
+      config_source
+    )
+  end
 end

data/spec/sample_files/_custom_index_and_error_docs.yml

@@ -0,0 +1,5 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket
+index_document: default.html
+error_document: 404.html

data/spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml

@@ -0,0 +1,12 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket
+index_document: default.html
+error_document: missing.html
+routing_rules:
+  - condition:
+      key_prefix_equals: blog/some_path
+    redirect:
+      host_name: blog.example.com
+      replace_key_prefix_with: some_new_path/
+      http_redirect_code: 301

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: configure-s3-website
 version: !ruby/object:Gem::Version
-  version: 1.4.0
-  prerelease: 
+  version: 1.5.0
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,11 +118,24 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 description: 
 email: lauri.lehmijoki@iki.fi
 executables:
@@ -192,36 +189,31 @@ files:
 - spec/sample_files/_config_file.yml
 - spec/sample_files/_config_file_oregon.yml
 - spec/sample_files/_config_file_with_eruby.yml
+- spec/sample_files/_custom_index_and_error_docs.yml
+- spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml
 - spec/xml_helper_spec.rb
 homepage: https://github.com/laurilehmijoki/configure-s3-website
 licenses: []
+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'
-      segments:
-      - 0
-      hash: 2506779264415997513
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2506779264415997513
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Configure your AWS S3 bucket to function as a web site
 test_files:
 - features/cassettes/cucumber_tags/apply-configs-on-cf-dist.yml
@@ -251,4 +243,6 @@ test_files:
 - spec/sample_files/_config_file.yml
 - spec/sample_files/_config_file_oregon.yml
 - spec/sample_files/_config_file_with_eruby.yml
+- spec/sample_files/_custom_index_and_error_docs.yml
+- spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml
 - spec/xml_helper_spec.rb