s3_website 0.1.0

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Build the project"
+task :default => 'test'
+
+desc "Run tests"
+task :test do
+  ENV['disable_parallel_processing'] = 'true'
+  sh "bundle exec rspec"
+  sh "bundle exec cucumber --tags ~@skip-on-travis"
+end
+
+desc 'Run work-in-progress features'
+task "cucumber:wip" do
+  ENV['disable_parallel_processing'] = 'true'
+  sh "bundle exec cucumber --tags @wip"
+end

data/bin/s3_website

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/s3_website'
+
+class Cfg < Thor
+  desc 'create', 'Create a config file with placeholder values'
+  def create
+    S3Website::Tasks.config_create parent_options[:site]
+  end
+end
+
+class Cli < Thor
+  class_option(
+    :site,
+    :type => :string,
+    :default => '_site',
+    :desc => 'The directory where your website files are'
+  )
+  option(
+    :headless,
+    :type => :boolean,
+    :desc =>
+      'When headless, s3_website will not require human interaction at any point'
+  )
+  desc 'push', 'Push local files with the S3 website'
+  long_desc <<-LONGDESC
+    `s3_website push` will upload new and changes files to S3. It will
+    also delete from S3 the files that you no longer have locally.
+  LONGDESC
+  def push
+    S3Website::Tasks.push(options[:site], options[:headless])
+  end
+
+  desc 'cfg SUBCOMMAND ...ARGS', 'Operate on the config file'
+  subcommand 'cfg', Cfg
+end
+
+Cli.start(ARGV)

data/changelog.md

@@ -0,0 +1,7 @@
+# Changelog
+
+This project uses [Semantic Versioning](http://semver.org).
+
+## HEAD
+
+* TBA

data/example-configurations.md

@@ -0,0 +1,60 @@
+# Example `s3_website` configurations
+
+This document shows examples of complete `s3_website.yml` configurations.
+
+## Minimal
+
+````yaml
+s3_id: abcd
+s3_secret: 2s+x92
+s3_bucket: your.domain.net
+````
+
+## Minimal with EC2 AIM roles
+
+````yaml
+s3_bucket: your.domain.net
+````
+
+If you run `s3_website` on an EC2 instance with IAM roles, it is possible to omit
+the `s3_id` and `s3_secret`.
+
+## Optimised for speed: using CloudFront, gzip and cache headers
+
+````yaml
+s3_id: <%= ENV['your_domain_net_aws_key'] %>
+s3_secret: <%= ENV['your_domain_net_aws_secret'] %>
+s3_bucket: your.domain.net
+cloudfront_distribution_id: <%= ENV['your_domain_net_cloudfront_distribution_id'] %>
+cloudfront_distribution_config:
+  default_cache_behavior:
+    min_TTL: <%= 60 * 60 * 24 %>
+  aliases:
+    quantity: 1
+    items:
+      CNAME: your.domain.net
+max_age: 120
+gzip: true
+````
+
+Above, we store the AWS credentials and the id of the CloudFront distribution as
+environment variables. It's convenient, since you can keep the `s3_website.yml`
+in a public Git repo, and thus have your deployment configurations
+version-controlled.
+
+## Using redirects
+
+````yaml
+s3_id: hello
+s3_secret: galaxy
+redirects:
+  index.php: /
+  about.php: about.html
+routing_rules:
+  - condition:
+      key_prefix_equals: code/repositories/git/
+    redirect:
+      host_name: git.johnny.com
+      replace_key_prefix_with: ""
+      http_redirect_code: 301
+````

data/features/as-library.feature

@@ -0,0 +1,29 @@
+Feature: Using s3_website as a library
+
+  As a developer
+  I want to programmatically use the s3_website API
+  So that I can extend my software with the capabilities of s3_website
+
+  @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
+
+  @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
+
+  @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
+
+  @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

data/features/cassettes/cucumber_tags/create-redirect.yml

@@ -0,0 +1,384 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://s3.amazonaws.com/s3-website-test.net?max-keys=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:09 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - kGCga6NIm0ybqHxPbkdrzL4YTE2Ik7Az88+JBSXk1uPWgj0a0ozR9z5BdOUOZSKy
+      X-Amz-Request-Id:
+      - 87A0319E10B35221
+      Date:
+      - Tue, 28 May 2013 16:43:53 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+
+        <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Name>s3-website-test.net</Name><Prefix></Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>.gitkeep</Key><LastModified>2013-05-28T16:27:36.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>'
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:09 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/s3-website-test.net/.gitkeep
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:09 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - bAn0wcE+zU2espZy2XzUQAoKBVY42UbUZ6ELx6Vm4MFsCynvMspnh9xHuPpbw4BR
+      X-Amz-Request-Id:
+      - 16821C1979EFD9FB
+      Date:
+      - Tue, 28 May 2013 16:43:54 GMT
+      Last-Modified:
+      - Tue, 28 May 2013 16:27:36 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Accept-Ranges:
+      - bytes
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:10 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/s3-website-test.net/.gitkeep
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:10 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - S4qbXk9empwOUKpUl3teDUGS60qYOg0CxRm7v8ccxa1Z5Y9K60DWvq8v7YHWAPWc
+      X-Amz-Request-Id:
+      - 62DB5F01C0BEF2BA
+      Date:
+      - Tue, 28 May 2013 16:43:54 GMT
+      Last-Modified:
+      - Tue, 28 May 2013 16:27:36 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Accept-Ranges:
+      - bytes
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:10 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/s3-website-test.net/.gitkeep
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:10 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - KIW+hvipZEv+PgPc03LeddPDEcI7EzDH/CuoxrksuGUIHeA3ecmbIA+jlOgpMCi7
+      X-Amz-Request-Id:
+      - CFFC7DE02A902B74
+      Date:
+      - Tue, 28 May 2013 16:43:55 GMT
+      Last-Modified:
+      - Tue, 28 May 2013 16:27:36 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Accept-Ranges:
+      - bytes
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:11 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/s3-website-test.net/welcome.php
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:11 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Amz-Request-Id:
+      - C3D38989428864B4
+      X-Amz-Id-2:
+      - iEtbd2+jBo4YB/bWQF7S0nIPD04ctKzv8FpUL3vTPUQzwpVE70mCORaHuXASL/6V
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 28 May 2013 16:43:54 GMT
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:12 GMT
+- request:
+    method: put
+    uri: https://s3.amazonaws.com/s3-website-test.net/welcome.php
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    headers:
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      X-Amz-Website-Redirect-Location:
+      - /welcome
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:12 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - shxpzCHDkXgP6Ru7MjzBbiiONhv8O72UHLa12njGg/Ml16sNy9kGzzCEUp4T450a
+      X-Amz-Request-Id:
+      - 73AD74BF97A9FE39
+      Date:
+      - Tue, 28 May 2013 16:43:56 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:12 GMT
+- request:
+    method: head
+    uri: https://s3.amazonaws.com/s3-website-test.net/pets/dogs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:12 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Amz-Request-Id:
+      - 720BC22A793D95A4
+      X-Amz-Id-2:
+      - pc2CHQG08/lLFwc/Cq3upvG3Sm+wDzsmf1FsA+YuUjkfojvJB45NbkL5LCX35bpi
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 28 May 2013 16:43:55 GMT
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:13 GMT
+- request:
+    method: put
+    uri: https://s3.amazonaws.com/s3-website-test.net/pets/dogs
+    body:
+      encoding: ASCII-8BIT
+      string: !binary ""
+    headers:
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      X-Amz-Website-Redirect-Location:
+      - /cats-and-dogs/wuf
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:13 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - qnGdeAUFkp76ErkCyx64T/eUilvlp2Y/b7QSCg5u+ghYyTtlR20szfiw0+tO/p7+
+      X-Amz-Request-Id:
+      - A38BEDA58C01CC5A
+      Date:
+      - Tue, 28 May 2013 16:43:57 GMT
+      Etag:
+      - ! '"d41d8cd98f00b204e9800998ecf8427e"'
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:14 GMT
+- request:
+    method: get
+    uri: https://s3.amazonaws.com/s3-website-test.net?max-keys=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.8.5 ruby/1.9.3 x86_64-darwin11.4.2
+      Date:
+      - Tue, 28 May 2013 16:44:14 GMT
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - SEAH/XjpATFm0o1XovAZAXLIsYIktpmxg986HNG//aMuvy+sDLmbee5d+fPpO+x0
+      X-Amz-Request-Id:
+      - 2C139CA22908CC7A
+      Date:
+      - Tue, 28 May 2013 16:43:58 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+
+        <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Name>s3-website-test.net</Name><Prefix></Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>.gitkeep</Key><LastModified>2013-05-28T16:27:36.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>pets/dogs</Key><LastModified>2013-05-28T16:43:57.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>welcome.php</Key><LastModified>2013-05-28T16:43:56.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>'
+    http_version: 
+  recorded_at: Tue, 28 May 2013 16:44:14 GMT
+recorded_with: VCR 2.3.0