s3_website 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55cbf48ece87058d058773afa873397466a7bb46
-  data.tar.gz: 23e1d2f8b50bad5582a3954fff956e5d401a4855
+  metadata.gz: f01a1cadbd9a8dcf5ff073f3b84ae1eca69d4fd3
+  data.tar.gz: 51193b4ace5ef371448d4378f67f0caa0ced7ff2
 SHA512:
-  metadata.gz: e23239516c9d32cf5a29bc826a5809635e17e20adfd8aa083a620e6ca9aa2ad8e8da29d467c2aeebe5732ea7516bd1f3a6024551739c85fe59ae13199fa3ad84
-  data.tar.gz: f6857264ecd3e9f88b92979c55d89a54800a14d2f07b325dce5871edc8eb5e6aeb4720c50d685dcdacbde379c3a3d3a76e707f2c01145e3539d5ea6ac5fe0f97
+  metadata.gz: b7943e03d17a5a5291eed51841434fb01d9fcdaa9e0d5e3dd87a697c2460060d209681f7a2c03df7a0a75dbc563365f3e9257d760921362575597c57160c825e
+  data.tar.gz: b5b10a4c5d399ec341e7f1051d652a85991f93aeb5ede93ce2fa360a4e62857b4158877777ffdb1deab34b1a5d82f37cba60986eb2bcb60d8dacbd8b2533cee9

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
 - 1.9.3
 - 2.0.0
+- 2.1.0

data/README.md

@@ -24,7 +24,8 @@
 
 Here's how you can get started:
 
-* In [AWS IAM](https://console.aws.amazon.com/iam), create API credentials that have sufficient permissions to S3
+* Create API credentials that have sufficient permissions to S3. More info
+  [here](https://github.com/laurilehmijoki/s3_website/blob/master/additional-docs/setting-up-aws-credentials.md).
 * Go to your website directory
 * Run `s3_website cfg create`. This generates a configuration file called `s3_website.yml`.
 * Put your AWS credentials and the S3 bucket name into the file
@@ -263,7 +264,7 @@ No more index.htmls in your URLs!
 
 *Note*: If the root resource on your folder displays an error instead of the
 index file, your source bucket in Cloudfront likely is pointing to the S3 Origin,
-*example.com.s3.amazonaws.com*. Update the source to the S3 Website Endpoint, 
+*example.com.s3.amazonaws.com*. Update the source to the S3 Website Endpoint,
 *e.g. example.com.s3-website-us-east-1.amazonaws.com*, to fix this.
 
 ### The headless mode
@@ -371,7 +372,7 @@ maximum open files (on Unix-like systems, see `man ulimit`) or decrease the
 ## Example configurations
 
 See
-<https://github.com/laurilehmijoki/s3_website/blob/master/example-configurations.md>.
+<https://github.com/laurilehmijoki/s3_website/blob/master/additional-docs/example-configurations.md>.
 
 ## Known issues
 
@@ -383,6 +384,10 @@ Please create an issue and send a pull request if you spot any.
 
 s3_website uses [Semantic Versioning](http://semver.org).
 
+In the spirit of semantic versioning, here is the definition of public API for
+s3_website: Within a major version, s3_website will not break
+backwards-compatibility of anything that is mentioned in this README file.
+
 ### Tests
 
   * Install bundler and run `bundle install`

data/{example-configurations.md → additional-docs/example-configurations.md}

@@ -37,7 +37,6 @@ cloudfront_distribution_config:
       CNAME: your.domain.net
 max_age: 120
 gzip: true
-concurrency_level: 100
 ````
 
 Above, we store the AWS credentials and the id of the CloudFront distribution as

data/additional-docs/setting-up-aws-credentials.md

@@ -0,0 +1,51 @@
+# Setting up AWS credentials
+
+Before starting to use s3\_website, you need to create AWS credentials.
+
+## Easy setup
+
+* Go to [AWS IAM console](https://console.aws.amazon.com/iam)
+* Create a new user that has full permissions to the S3 and CloudFront services
+* Call `s3_website cfg create` and place the credentials of your new AWS user
+  into the *s3_website.yml* file
+* Read the main documentation for further info
+
+## Limiting the permissions of the credentials
+
+AWS IAM offers multiple ways of limiting the permissions of a user. Below is one
+way of configuring the limitations and yet retaining the capability to use all
+s3\_website features.
+
+If you know the hostname of your public website (say `my.website.com`), perform the
+following steps:
+
+* Create a user that has full permissions to the S3 bucket
+* In addition, let the user have full permissions to CloudFront
+
+Here is the IAM Policy Document of the above setup:
+
+```json
+{
+  "Statement": [
+    {
+      "Action": [
+        "cloudfront:*"
+      ],
+      "Effect": "Allow",
+      "Resource": [
+        "*"
+      ]
+    },
+    {
+      "Action": [
+        "s3:*"
+      ],
+      "Effect": "Allow",
+      "Resource": [
+        "arn:aws:s3:::my.website.com",
+        "arn:aws:s3:::my.website.com/*"
+      ]
+    }
+  ]
+}
+```

data/bin/s3_website

@@ -8,6 +8,7 @@ class Cfg < Thor
     S3Website::Tasks.config_create Dir.pwd
   rescue Exception => e
     puts S3Website.error_report e
+    exit 1
   end
 
   desc 'apply', 'Apply the configuration on the AWS services'
@@ -28,6 +29,7 @@ class Cfg < Thor
     })
   rescue Exception => e
     puts S3Website.error_report e
+    exit 1
   end
 end
 
@@ -60,6 +62,7 @@ class Cli < Thor
     S3Website::Tasks.push(options[:config_dir], site_path, options[:headless])
   rescue Exception => e
     puts S3Website.error_report e
+    exit 1
   end
 
   desc 'cfg SUBCOMMAND ...ARGS', 'Operate on the config file'

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 1.6.5
+
+* In case of error, exit with status 1
+
 ## 1.6.4
 
 * Add systematic error handling

data/features/as-library.feature

@@ -7,23 +7,23 @@ Feature: Using s3_website as a library
   @one-file-to-delete
   Scenario: Developer wants feedback on how many files s3_website deleted
     When my S3 website is in "features/support/test_site_dirs/unpublish-a-post.com"
-    Then s3_website will push my blog to S3
-    And report that it deleted 1 file from S3
+    And I call the push command
+    Then s3_website should report that it deleted 1 file from S3
 
   @new-and-changed-files
   Scenario: Developer wants feedback on how many files s3_website uploaded
     When my S3 website is in "features/support/test_site_dirs/new-and-changed-files.com"
-    Then s3_website will push my blog to S3
-    And report that it uploaded 1 new and 1 changed files into S3
+    And I call the push command
+    Then s3_website should report that it uploaded 1 new and 1 changed files into S3
 
   @s3-and-cloudfront-when-updating-a-file
   Scenario: Developer wants feedback on how many Cloudfront items s3_website invalidated
     When my S3 website is in "features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi"
-    Then s3_website will push my blog to S3 and invalidate the Cloudfront distribution
-    And report that it invalidated 2 Cloudfront item
+    And I call the push command
+    Then s3_website should report that it invalidated 2 Cloudfront item
 
   @create-redirect
   Scenario: Developer wants feedback on how many redirects s3_website created
     When my S3 website is in "features/support/test_site_dirs/create-redirects"
-    Then s3_website will push my blog to S3
-    And report that it created 2 new redirects
+    And I call the push command
+    Then s3_website should report that it created 2 new redirects

data/features/cloudfront.feature

@@ -9,8 +9,8 @@ Feature: Invalidate the Cloudfront distribution
   @s3-and-cloudfront
   Scenario: Upload to S3 and then invalidate the Cloudfront distribution
     When my S3 website is in "features/support/test_site_dirs/cdn-powered.blog.fi"
-    Then s3_website will push my blog to S3 and invalidate the Cloudfront distribution
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Invalidating Cloudfront items...
         /
@@ -20,8 +20,8 @@ Feature: Invalidate the Cloudfront distribution
   @s3-and-cloudfront-when-updating-a-file
   Scenario: Update a blog entry and then upload
     When my S3 website is in "features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi"
-    Then s3_website will push my blog to S3 and invalidate the Cloudfront distribution
-    And the output should equal
+    And I call the push command
+    Then the output should equal
       """
       Deploying features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi/_site/* to s3-website-test.net
       Calculating diff ... done
@@ -38,8 +38,8 @@ Feature: Invalidate the Cloudfront distribution
   @s3-and-cloudfront-after-deleting-a-file
   Scenario: Delete a blog post and then push the website
     When my S3 website is in "features/support/test_site_dirs/cdn-powered.when-deleted-a-file.blog.fi"
-    Then s3_website will push my blog to S3 and invalidate the Cloudfront distribution
-    And the output should equal
+    And I call the push command
+    Then the output should equal
       """
       Deploying features/support/test_site_dirs/cdn-powered.when-deleted-a-file.blog.fi/_site/* to s3-website-test.net
       Calculating diff ... done

data/features/delete.feature

@@ -7,8 +7,8 @@ Feature: remove an S3 website page from S3
   @one-file-to-delete
   Scenario: The user deletes a blog post
     When my S3 website is in "features/support/test_site_dirs/unpublish-a-post.com"
-    Then s3_website will push my blog to S3
-    And the output should equal
+    And I call the push command
+    Then the output should equal
       """
       Deploying features/support/test_site_dirs/unpublish-a-post.com/_site/* to s3-website-test.net
       Calculating diff ... done

data/features/error_reporting.feature

@@ -5,7 +5,7 @@ Feature: reporting errors to the user
 
   @starts-new-os-process
   @network-io
-  Scenario: The S3 credentials are invalid
+  Scenario: The user calls "push" when the S3 credentials are invalid
     When I run `s3_website push --site ../../features/support/test_site_dirs/my.blog.com --config_dir ../../features/support/test_site_dirs/my.blog.com`
     Then the output should contain:
       """
@@ -15,3 +15,10 @@ Feature: reporting errors to the user
       """
       throw
       """
+    And the exit status should be 1
+
+  @starts-new-os-process
+  @network-io
+  Scenario: The user calls "cfg apply" when the S3 credentials are invalid
+    When I run `s3_website cfg apply`
+    And the exit status should be 1

data/features/instructions-for-new-user.feature

@@ -12,6 +12,11 @@ Feature: Instructions for a new user
       I can't find a website in any of the following directories: public/output, _site. Please specify the location of the website with the --site option.
       """
 
+  @starts-new-os-process
+  Scenario: Configuration is incomplete
+    When I run `s3_website push`
+    Then the exit status should be 1
+
   @starts-new-os-process
   Scenario: Create placeholder config file
     Given a directory named "_site"
@@ -142,8 +147,8 @@ Feature: Instructions for a new user
   @new-files
   Scenario: Print the URL of the to the user
     When my S3 website is in "features/support/test_site_dirs/my.blog.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Go visit: http://s3-website-test.net.s3-website-us-east-1.amazonaws.com/index.html
       """

data/features/jekyll-support.feature

@@ -3,8 +3,8 @@ Feature: upload a Jekyll site
   @new-files
   Scenario: Push a Jekyll site to S3
     When my S3 website is in "features/support/test_site_dirs/jekyllrb.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Deploying features/support/test_site_dirs/jekyllrb.com/_site/* to s3-website-test.net
       Calculating diff ... done

data/features/nanoc-support.feature

@@ -3,8 +3,8 @@ Feature: upload a Nanoc site
   @new-files
   Scenario: Push a Nanoc site to S3
     When my S3 website is in "features/support/test_site_dirs/nanoc.ws"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Deploying features/support/test_site_dirs/nanoc.ws/public/output/* to s3-website-test.net
       Calculating diff ... done

data/features/push.feature

@@ -7,8 +7,8 @@ Feature: upload S3 website to S3
   @new-files
   Scenario: Push a new S3 website to S3
     When my S3 website is in "features/support/test_site_dirs/my.blog.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Deploying features/support/test_site_dirs/my.blog.com/_site/* to s3-website-test.net
       Calculating diff ... done
@@ -43,8 +43,8 @@ Feature: upload S3 website to S3
   @new-files-for-sydney
   Scenario: Push a new S3 website to an S3 bucket in Sydney
     When my S3 website is in "features/support/test_site_dirs/my.sydney.blog.au"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Done! Go visit: http://s3-website-test.net.s3-website-ap-southeast-2.amazonaws.com/index.html
       """
@@ -52,8 +52,8 @@ Feature: upload S3 website to S3
   @new-and-changed-files
   Scenario: Upload a new blog post and change an old post
     When my S3 website is in "features/support/test_site_dirs/new-and-changed-files.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Deploying features/support/test_site_dirs/new-and-changed-files.com/_site/* to s3-website-test.net
       Calculating diff ... done
@@ -76,8 +76,8 @@ Feature: upload S3 website to S3
   @only-changed-files
   Scenario: Update an existing blog post
     When my S3 website is in "features/support/test_site_dirs/only-changed-files.com"
-    Then s3_website will push my blog to S3
-    And the output should equal
+    And I call the push command
+    Then the output should equal
       """
       Deploying features/support/test_site_dirs/only-changed-files.com/_site/* to s3-website-test.net
       Calculating diff ... done
@@ -90,8 +90,8 @@ Feature: upload S3 website to S3
   @no-new-or-changed-files
   Scenario: The user runs s3_website even though he doesn't have new or changed posts
     When my S3 website is in "features/support/test_site_dirs/no-new-or-changed-files.com"
-    Then s3_website will push my blog to S3
-    And the output should equal
+    And I call the push command
+    Then the output should equal
       """
       Deploying features/support/test_site_dirs/no-new-or-changed-files.com/_site/* to s3-website-test.net
       Calculating diff ... done
@@ -103,8 +103,8 @@ Feature: upload S3 website to S3
   @new-and-changed-files
   Scenario: The blogger user does not want to upload certain files
     When my S3 website is in "features/support/test_site_dirs/ignored-files.com"
-    Then s3_website will push my blog to S3
-    And the output should equal
+    And I call the push command
+    Then the output should equal
       """
       Deploying features/support/test_site_dirs/ignored-files.com/_site/* to s3-website-test.net
       Calculating diff ... done

data/features/redirects.feature

@@ -3,8 +3,8 @@ Feature: configure redirects
   @create-redirect
   Scenario: The user wants to configure new redirects for HTTP resources
     When my S3 website is in "features/support/test_site_dirs/create-redirects"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Creating new redirects ...
         Redirect welcome.php to /welcome: Success!

data/features/security.feature

@@ -3,8 +3,8 @@ Feature: Security
   @empty-bucket
   Scenario: The user does not want to upload the s3_website.yml file
     When my S3 website is in "features/support/test_site_dirs/site-that-contains-s3-website-file.com"
-    Then s3_website will push my blog to S3
-    And the output should not contain "s3_website.yml"
+    And I call the push command
+    Then the output should not contain "s3_website.yml"
     And the output should equal
       """
       Deploying features/support/test_site_dirs/site-that-contains-s3-website-file.com/_site/* to another-s3-website-test.net

data/features/step_definitions/steps.rb

@@ -4,11 +4,7 @@ When /^my S3 website is in "(.*?)"$/ do |blog_dir|
   @blog_dir = blog_dir
 end
 
-When /^s3_website will push my blog to S3$/ do
-  push_files
-end
-
-Then /^s3_website will push my blog to S(\d+) and invalidate the Cloudfront distribution$/ do |args|
+When /^I call the push command$/ do
   push_files
 end
 
@@ -20,21 +16,21 @@ Then /^the output should contain$/ do |expected_console_output|
   @console_output.should include(expected_console_output)
 end
 
-Then /^report that it uploaded (\d+) new and (\d+) changed files into S3$/ do
+Then /^s3_website should report that it uploaded (\d+) new and (\d+) changed files into S3$/ do
   |new_count, changed_count|
   @amount_of_new_files.should == new_count.to_i
   @amount_of_changed_files.should == changed_count.to_i
 end
 
-Then /^report that it invalidated (\d+) Cloudfront item$/ do |expected|
+Then /^s3_website should 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|
+Then /^s3_website should 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|
+Then /^s3_website should 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
 

data/features/website-performance.feature

@@ -7,8 +7,8 @@ Feature: improve response times of your S3 website website
   @new-files
   Scenario: Set Cache-Control: max-age for all uploaded files
     When my S3 website is in "features/support/test_site_dirs/site.with.maxage.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Upload css/styles.css [max-age=120]: Success!
       """
@@ -20,8 +20,8 @@ Feature: improve response times of your S3 website website
   @new-files
   Scenario: Set Cache-Control: max-age for CSS files only
     When my S3 website is in "features/support/test_site_dirs/site.with.css-maxage.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Upload css/styles.css [max-age=100]: Success!
       """
@@ -33,8 +33,8 @@ Feature: improve response times of your S3 website website
   @new-files
   Scenario: Set Content-Encoding: gzip HTTP header for HTML files
     When my S3 website is in "features/support/test_site_dirs/site.with.gzipped-html.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Upload css/styles.css: Success!
       """
@@ -46,8 +46,8 @@ Feature: improve response times of your S3 website website
   @new-files
   Scenario: Set both the Content-Encoding: gzip and Cache-Control: max-age headers
     When my S3 website is in "features/support/test_site_dirs/site.with.gzipped-and-max-aged-content.com"
-    Then s3_website will push my blog to S3
-    And the output should contain
+    And I call the push command
+    Then the output should contain
       """
       Upload css/styles.css [gzipped] [max-age=300]: Success!
       """

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.6.4"
+  s.version     = "1.6.5"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Lauri Lehmijoki"]
   s.email       = ["lauri.lehmijoki@iki.fi"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.6.5
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -221,9 +221,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- additional-docs/example-configurations.md
+- additional-docs/setting-up-aws-credentials.md
 - bin/s3_website
 - changelog.md
-- example-configurations.md
 - features/as-library.feature
 - features/cassettes/cucumber_tags/create-redirect.yml
 - features/cassettes/cucumber_tags/empty-bucket.yml