jekyll-s3 2.2.4 → 2.3.0

data/README.md

@@ -33,6 +33,20 @@ s3_bucket: your.blog.bucket.com
 
 ## Additional features
 
+### Using non-standard AWS regions
+
+By default, `jekyll-s3` uses the US Standard Region. You can upload your Jekyll
+site to other regions by adding the setting `s3_endpoint` into the
+`_jekyll_s3.yml` file.
+
+For example, the following line in `_jekyll_s3.yml` will instruct `jekyll_s3` to
+push your site into the Tokyo region:
+
+    s3_endpoint: ap-northeast-1
+
+The valid `s3_endpoint` values consist of the [S3 location constraint
+values](http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region).
+
 ### Reduced Redundancy
 
 You can reduce the cost of hosting your blog on S3 by using Reduced Redundancy Storage:

data/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.3.0
+
+* Add support for non-standard AWS regions
+
+  You can now define the region with the `s3_endpoint` in the configuration
+  file.
+
 ## 2.2.4
 
 * Print the web site URL instead of the bucket URL

data/features/cassettes/cucumber_tags/new-files-for-sydney.yml

@@ -0,0 +1,211 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://s3-ap-southeast-2.amazonaws.com/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.5.6 ruby/1.9.3 x86_64-darwin11.4.0
+      Date:
+      - Sun, 14 Oct 2012 16:40:24 +0300
+      Authorization:
+      - AWS foo:foo=
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - oPO1kjdvRumCNZHfhZaWYgyeqf1rszjLU6Yv5VmeJlagrp0L7xDlja33A3NEB+lF
+      X-Amz-Request-Id:
+      - 0ADF25683FCFEA3B
+      Date:
+      - Sun, 14 Oct 2012 13:40:27 GMT
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+
+        <ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Owner><ID>x</ID><DisplayName>x</DisplayName></Owner><Buckets><Bucket><Name>jekyll-s3-test.net</Name><CreationDate>2012-10-14T12:58:37.000Z</CreationDate></Bucket></Buckets></ListAllMyBucketsResult>'
+    http_version:
+  recorded_at: Sun, 14 Oct 2012 13:40:25 GMT
+- request:
+    method: get
+    uri: https://s3-ap-southeast-2.amazonaws.com/jekyll-s3-test.net?max-keys=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.5.6 ruby/1.9.3 x86_64-darwin11.4.0
+      Date:
+      - Sun, 14 Oct 2012 16:40:25 +0300
+      Authorization:
+      - AWS foo:foo=
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - QTSymXMQalg5cw/APPEwt9g6sYMDXbxW0Aaps1zAQ0u/4SwrvkOeNt3jKm54/VMM
+      X-Amz-Request-Id:
+      - AA208FECCB1E85EE
+      Date:
+      - Sun, 14 Oct 2012 13:40:27 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>jekyll-s3-test.net</Name><Prefix></Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated></ListBucketResult>'
+    http_version:
+  recorded_at: Sun, 14 Oct 2012 13:40:26 GMT
+- request:
+    method: put
+    uri: https://s3-ap-southeast-2.amazonaws.com/jekyll-s3-test.net/css/styles.css
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        Ym9keSB7Cgp9Cg==
+    headers:
+      Content-Type:
+      - ''
+      Content-Length:
+      - '10'
+      User-Agent:
+      - aws-sdk-ruby/1.5.6 ruby/1.9.3 x86_64-darwin11.4.0
+      Date:
+      - Sun, 14 Oct 2012 16:40:26 +0300
+      Authorization:
+      - AWS foo:foo=
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - xhRbNnKb3BflLa4OrGe9qeM2gSadOHcnWNdpqaMwEYL909QAoBkaUTJZGqcYABhq
+      X-Amz-Request-Id:
+      - E5428005DF85FB78
+      Date:
+      - Sun, 14 Oct 2012 13:40:28 GMT
+      Etag:
+      - ! '"8fcf43a38cbf0c502f029a50645f2374"'
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Sun, 14 Oct 2012 13:40:26 GMT
+- request:
+    method: put
+    uri: https://s3-ap-southeast-2.amazonaws.com/jekyll-s3-test.net/index.html
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        PGh0bWw+CiAgPGhlYWQ+CiAgICA8dGl0bGU+aGVsbG8hPC90aXRsZT4KICA8
+        L2hlYWQ+CjwvaHRtbD4K
+    headers:
+      Content-Type:
+      - ''
+      Content-Length:
+      - '60'
+      User-Agent:
+      - aws-sdk-ruby/1.5.6 ruby/1.9.3 x86_64-darwin11.4.0
+      Date:
+      - Sun, 14 Oct 2012 16:40:26 +0300
+      Authorization:
+      - AWS foo:foo=
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - /qDHDvVyWt95mWDmaswN75KKtnBPN2ISIlgdBOFSvWyy/Ovva2u8SMDd4aQJSoVj
+      X-Amz-Request-Id:
+      - EDC7726801AA0AE2
+      Date:
+      - Sun, 14 Oct 2012 13:40:29 GMT
+      Etag:
+      - ! '"8a8892a2b0fad281f26c0dedbff7011a"'
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Sun, 14 Oct 2012 13:40:27 GMT
+- request:
+    method: get
+    uri: https://s3-ap-southeast-2.amazonaws.com/jekyll-s3-test.net?max-keys=1000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - ''
+      User-Agent:
+      - aws-sdk-ruby/1.5.6 ruby/1.9.3 x86_64-darwin11.4.0
+      Date:
+      - Sun, 14 Oct 2012 16:40:27 +0300
+      Authorization:
+      - AWS foo:foo
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - ZIix7PUbt+Kpmb1wbV5hYk4fPyZYjj9doj54LQAQjsXqskA7Yk442vj47FeoD6sC
+      X-Amz-Request-Id:
+      - 62CBD66CCEB953BA
+      Date:
+      - Sun, 14 Oct 2012 13:40:29 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>jekyll-s3-test.net</Name><Prefix></Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>css/styles.css</Key><LastModified>2012-10-14T13:40:28.000Z</LastModified><ETag>&quot;8fcf43a38cbf0c502f029a50645f2374&quot;</ETag><Size>10</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>index.html</Key><LastModified>2012-10-14T13:40:29.000Z</LastModified><ETag>&quot;8a8892a2b0fad281f26c0dedbff7011a&quot;</ETag><Size>60</Size><Owner><ID>3855ebae0f370c3dd0c8d8031863792112bd2a2cb18fa310d3f463ae0dea62f1</ID><DisplayName>fluid83</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>'
+    http_version:
+  recorded_at: Sun, 14 Oct 2012 13:40:28 GMT
+recorded_with: VCR 2.2.4

data/features/jekyll-s3-upload.feature

@@ -18,6 +18,16 @@ Feature: upload Jekyll site to S3
 
       """
 
+  @new-files-for-sydney
+  @wip
+  Scenario: Push a new Jekyll site to an S3 bucket in Sydney
+    When my Jekyll site is in "features/support/test_site_dirs/my.sydney.blog.au"
+    Then jekyll-s3 will push my blog to S3
+    And the output should contain
+      """
+      Done! Go visit: http://jekyll-s3-test.net.s3-website-ap-southeast-2.amazonaws.com/index.html
+      """
+
   @new-and-changed-files
   Scenario: Upload a new blog post and change an old post
     When my Jekyll site is in "features/support/test_site_dirs/new-and-changed-files.com"

data/features/support/test_site_dirs/my.sydney.blog.au/_jekyll_s3.yml

@@ -0,0 +1,4 @@
+s3_id: key
+s3_secret: pass
+s3_bucket: jekyll-s3-test.net
+s3_endpoint: ap-southeast-2

data/features/support/test_site_dirs/my.sydney.blog.au/_site/css/styles.css

@@ -0,0 +1,3 @@
+body {
+
+}

data/features/support/test_site_dirs/my.sydney.blog.au/_site/index.html

@@ -0,0 +1,5 @@
+<html>
+  <head>
+    <title>hello!</title>
+  </head>
+</html>

data/features/support/vcr.rb

@@ -7,6 +7,7 @@ end
 
 VCR.cucumber_tags do |t|
   t.tag '@new-files'
+  t.tag '@new-files-for-sydney'
   t.tag '@new-and-changed-files'
   t.tag '@only-changed-files'
   t.tag '@no-new-or-changed-files'

data/jekyll-s3.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "jekyll-s3"
-  s.version     = "2.2.4"
+  s.version     = "2.3.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
   s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]
@@ -20,7 +20,7 @@ distribution, making it easy to deliver your blog via the CDN.}
   s.add_dependency 'simple-cloudfront-invalidator', '~> 1.0'
   s.add_dependency 'erubis', '~> 2.7.0'
   s.add_dependency 'mime-types', '= 1.19'
-  s.add_dependency 'configure-s3-website', '~> 1.0'
+  s.add_dependency 'configure-s3-website', '~> 1.1'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-expectations'

data/lib/jekyll-s3.rb

@@ -11,7 +11,7 @@ module Jekyll
   end
 end
 
-%w{errors uploader cli config_loader retry keyboard diff_helper}.each do |file|
+%w{errors uploader cli config_loader retry keyboard diff_helper endpoint}.each do |file|
   require File.dirname(__FILE__) + "/jekyll-s3/#{file}"
 end
 

data/lib/jekyll-s3/config_loader.rb

@@ -24,10 +24,7 @@ s3_bucket: your.blog.bucket.com
       # Raise MalformedConfigurationFileError if the configuration file does not contain the keys we expect
       def self.load_configuration(site_dir)
         config = load_yaml_file_and_validate site_dir
-        s3_id = config['s3_id']
-        s3_secret = config['s3_secret']
-        s3_bucket = config['s3_bucket']
-        cloudfront_distribution_id = config['cloudfront_distribution_id']
+        config['s3_endpoint'] = config['s3_endpoint'] || 'us-east-1'
         return config
       end
 

data/lib/jekyll-s3/endpoint.rb

@@ -0,0 +1,30 @@
+module Jekyll
+  module S3
+    class Endpoint
+      attr_reader :region, :location_constraint, :hostname, :website_hostname
+
+      def initialize(location_constraint)
+        raise "Invalid S3 location constraint #{location_constraint}" unless
+          location_constraints.has_key?location_constraint
+        @region = location_constraints.fetch(location_constraint)[:region]
+        @hostname = location_constraints.fetch(location_constraint)[:endpoint]
+        @website_hostname = location_constraints.fetch(location_constraint)[:website_hostname]
+        @location_constraint = location_constraint
+      end
+
+      # http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region
+      def location_constraints
+        {
+          'us-east-1'      => { :region => 'US Standard',                   :website_hostname => 's3-website-us-east-1.amazonaws.com',      :endpoint => 's3.amazonaws.com' },
+          'us-west-2'      => { :region => 'US West (Oregon)',              :website_hostname => 's3-website-us-west-2.amazonaws.com',      :endpoint => 's3-us-west-2.amazonaws.com' },
+          'us-west-1'      => { :region => 'US West (Northern California)', :website_hostname => 's3-website-us-west-1.amazonaws.com',      :endpoint => 's3-us-west-1.amazonaws.com' },
+          'EU'             => { :region => 'EU (Ireland)',                  :website_hostname => 's3-website-eu-west-1.amazonaws.com',      :endpoint => 's3-eu-west-1.amazonaws.com' },
+          'ap-southeast-1' => { :region => 'Asia Pacific (Singapore)',      :website_hostname => 's3-website-ap-southeast-1.amazonaws.com', :endpoint => 's3-ap-southeast-1.amazonaws.com' },
+          'ap-southeast-2' => { :region => 'Asia Pacific (Sydney)',         :website_hostname => 's3-website-ap-southeast-2.amazonaws.com', :endpoint => 's3-ap-southeast-2.amazonaws.com' },
+          'ap-northeast-1' => { :region => 'Asia Pacific (Tokyo)',          :website_hostname => 's3-website-ap-northeast-1.amazonaws.com', :endpoint => 's3-ap-northeast-1.amazonaws.com' },
+          'sa-east-1'      => { :region => 'South America (Sao Paulo)',     :website_hostname => 's3-website-sa-east-1.amazonaws.com',      :endpoint => 's3-sa-east-1.amazonaws.com' }
+        }
+      end
+  end
+  end
+end

data/lib/jekyll-s3/uploader.rb

@@ -5,7 +5,8 @@ module Jekyll
         puts "Deploying _site/* to #{config['s3_bucket']}"
 
         s3 = AWS::S3.new(:access_key_id => config['s3_id'],
-                         :secret_access_key => config['s3_secret'])
+                         :secret_access_key => config['s3_secret'],
+                         :s3_endpoint => Endpoint.new(config['s3_endpoint']).hostname )
 
         new_files_count, changed_files_count, changed_files = upload_files(
           s3, config, site_dir
@@ -23,10 +24,10 @@ module Jekyll
 
       def self.print_done_report(config)
         bucket_name = config['s3_bucket']
-        s3_end_point = "us-east-1"
-        web_site_host_name =
-          "%s.s3-website-%s.amazonaws.com" % [bucket_name, s3_end_point]
-        puts "Done! Go visit: http://#{web_site_host_name}/index.html"
+        website_hostname_suffix = Endpoint.new(config['s3_endpoint']).website_hostname
+        website_hostname_with_bucket =
+          "%s.%s" % [bucket_name, website_hostname_suffix]
+        puts "Done! Go visit: http://#{website_hostname_with_bucket}/index.html"
       end
 
       def self.upload_files(s3, config, site_dir)

data/spec/lib/config_loader_spec.rb

@@ -7,4 +7,14 @@ describe Jekyll::S3::ConfigLoader do
     config['s3_secret'].should eq('world')
     config['s3_bucket'].should eq('galaxy')
   end
+
+  it 'uses the "us-east-1" as the default endpoint' do
+    config = Jekyll::S3::ConfigLoader.load_configuration('spec/sample_files/hyde_site/_site')
+    config['s3_endpoint'].should eq('us-east-1')
+  end
+
+  it 'reads the S3 endpoint setting from _jekyll_s3.yml' do
+    config = Jekyll::S3::ConfigLoader.load_configuration('spec/sample_files/tokyo_site/_site')
+    config['s3_endpoint'].should eq('ap-northeast-1')
+  end
 end

data/spec/sample_files/tokyo_site/_jekyll_s3.yml

@@ -0,0 +1,4 @@
+s3_id: <%= 'hello' %>
+s3_secret: <%= 'world' %>
+s3_bucket: galaxy
+s3_endpoint: ap-northeast-1

data/spec/sample_files/tokyo_site/_site/.vimrc

@@ -0,0 +1,5 @@
+" Disable the arrow keys in the normal mode – using them there only slows you down. Use hkjl instead.
+map <Left> :echo "no!"<cr>
+map <Right> :echo "no!"<cr>
+map <Up> :echo "no!"<cr>
+map <Down> :echo "no!"<cr>

data/spec/sample_files/tokyo_site/_site/css/styles.css

@@ -0,0 +1,3 @@
+body {
+
+}

data/spec/sample_files/tokyo_site/_site/index.html

@@ -0,0 +1 @@
+<div>Hello world</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-s3
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -99,7 +99,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -241,6 +241,7 @@ files:
 - bin/jekyll-s3
 - changelog.md
 - features/cassettes/cucumber_tags/new-and-changed-files.yml
+- features/cassettes/cucumber_tags/new-files-for-sydney.yml
 - features/cassettes/cucumber_tags/new-files.yml
 - features/cassettes/cucumber_tags/no-new-or-changed-files.yml
 - features/cassettes/cucumber_tags/one-file-to-delete.yml
@@ -263,6 +264,9 @@ files:
 - features/support/test_site_dirs/my.blog.com/_jekyll_s3.yml
 - features/support/test_site_dirs/my.blog.com/_site/css/styles.css
 - features/support/test_site_dirs/my.blog.com/_site/index.html
+- features/support/test_site_dirs/my.sydney.blog.au/_jekyll_s3.yml
+- features/support/test_site_dirs/my.sydney.blog.au/_site/css/styles.css
+- features/support/test_site_dirs/my.sydney.blog.au/_site/index.html
 - features/support/test_site_dirs/new-and-changed-files.com/_jekyll_s3.yml
 - features/support/test_site_dirs/new-and-changed-files.com/_site/css/styles.css
 - features/support/test_site_dirs/new-and-changed-files.com/_site/index.html
@@ -281,6 +285,7 @@ files:
 - lib/jekyll-s3/cli.rb
 - lib/jekyll-s3/config_loader.rb
 - lib/jekyll-s3/diff_helper.rb
+- lib/jekyll-s3/endpoint.rb
 - lib/jekyll-s3/errors.rb
 - lib/jekyll-s3/keyboard.rb
 - lib/jekyll-s3/retry.rb
@@ -293,6 +298,10 @@ files:
 - spec/sample_files/hyde_site/_site/.vimrc
 - spec/sample_files/hyde_site/_site/css/styles.css
 - spec/sample_files/hyde_site/_site/index.html
+- spec/sample_files/tokyo_site/_jekyll_s3.yml
+- spec/sample_files/tokyo_site/_site/.vimrc
+- spec/sample_files/tokyo_site/_site/css/styles.css
+- spec/sample_files/tokyo_site/_site/index.html
 - spec/spec_helper.rb
 homepage: https://github.com/laurilehmijoki/jekyll-s3
 licenses: []
@@ -320,6 +329,7 @@ specification_version: 3
 summary: Push your Jekyll blog to S3
 test_files:
 - features/cassettes/cucumber_tags/new-and-changed-files.yml
+- features/cassettes/cucumber_tags/new-files-for-sydney.yml
 - features/cassettes/cucumber_tags/new-files.yml
 - features/cassettes/cucumber_tags/no-new-or-changed-files.yml
 - features/cassettes/cucumber_tags/one-file-to-delete.yml
@@ -342,6 +352,9 @@ test_files:
 - features/support/test_site_dirs/my.blog.com/_jekyll_s3.yml
 - features/support/test_site_dirs/my.blog.com/_site/css/styles.css
 - features/support/test_site_dirs/my.blog.com/_site/index.html
+- features/support/test_site_dirs/my.sydney.blog.au/_jekyll_s3.yml
+- features/support/test_site_dirs/my.sydney.blog.au/_site/css/styles.css
+- features/support/test_site_dirs/my.sydney.blog.au/_site/index.html
 - features/support/test_site_dirs/new-and-changed-files.com/_jekyll_s3.yml
 - features/support/test_site_dirs/new-and-changed-files.com/_site/css/styles.css
 - features/support/test_site_dirs/new-and-changed-files.com/_site/index.html
@@ -362,4 +375,8 @@ test_files:
 - spec/sample_files/hyde_site/_site/.vimrc
 - spec/sample_files/hyde_site/_site/css/styles.css
 - spec/sample_files/hyde_site/_site/index.html
+- spec/sample_files/tokyo_site/_jekyll_s3.yml
+- spec/sample_files/tokyo_site/_site/.vimrc
+- spec/sample_files/tokyo_site/_site/css/styles.css
+- spec/sample_files/tokyo_site/_site/index.html
 - spec/spec_helper.rb