configure-s3-website 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configure-s3-website (0.0.1)
+    configure-s3-website (1.0.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -6,8 +6,7 @@
 Configure an AWS S3 bucket to function as a website. Easily from the
 command-line interface.
 
-The Ruby gem `configure-s3-website` can configure an S3 bucket to function as a
-website. The bucket may or may not exist. If the bucket does not exist,
+The bucket may or may not exist. If the bucket does not exist,
 `configure-s3-website` will create it.
 
 ## Install
@@ -32,6 +31,19 @@ following command:
 Congratulations! You now have an S3 bucket that can act as a website server for
 you.
 
+### Specifying a non-standard S3 endpoint
+
+By default, `configure-s3-website` creates the S3 website into the US Standard
+region.
+
+If you want to create the website into another region, add into the
+configuration file a row like this:
+
+    s3_endpoint: EU
+
+The valid *s3_endpoint* values consist of the [S3 location constraint
+values](http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region).
+
 ## How does `configure-s3-website` work?
 
 It calls the [PUT Bucket
@@ -69,4 +81,4 @@ API with the following JSON:
 
 ## License
 
-See file LICENSE.
+See the file LICENSE.

data/changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.1.0
+
+* Add support for non-standard AWS regions

data/configure-s3-website.gemspec

@@ -6,7 +6,7 @@ spec = Gem::Specification.new do |s|
   s.email = 'lauri.lehmijoki@iki.fi'
   s.homepage = 'https://github.com/laurilehmijoki/configure-s3-website'
   s.platform = Gem::Platform::RUBY
-  s.summary = 'Configure your S3 bucket to function as a web site'
+  s.summary = 'Configure your AWS S3 bucket to function as a web site'
   s.bindir = 'bin'
 
   s.add_development_dependency 'rspec', '~> 2.10.0'

data/features/cassettes/cucumber_tags/bucket-does-not-exist-in-tokyo.yml

@@ -0,0 +1,159 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://s3-ap-northeast-1.amazonaws.com/name-of-a-new-bucket/?website
+    body:
+      encoding: US-ASCII
+      string: ! "\n        <WebsiteConfiguration xmlns='http://s3.amazonaws.com/doc/2006-03-01/'>\n
+        \         <IndexDocument>\n            <Suffix>index.html</Suffix>\n          </IndexDocument>\n
+        \         <ErrorDocument>\n            <Key>error.html</Key>\n          </ErrorDocument>\n
+        \       </WebsiteConfiguration>\n      "
+    headers:
+      Date:
+      - Sun, 30 Dec 2012 19:59:34 EET
+      Content-Type:
+      - ''
+      Content-Length:
+      - '298'
+      Authorization:
+      - AWS foo
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Amz-Request-Id:
+      - CD16DF6FF66B5922
+      X-Amz-Id-2:
+      - Xu30q0VM0aaYY091koYh8FIUDPB2KWOQLRPqnLulIK3ScIrMWgOwF7M2XRYIi5Vs
+      Content-Type:
+      - application/xml
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Sun, 30 Dec 2012 17:59:34 GMT
+      Connection:
+      - close
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8"?>
+
+        <Error><Code>NoSuchBucket</Code><Message>The specified bucket does not exist</Message><BucketName>name-of-a-new-bucket</BucketName><RequestId>CD16DF6FF66B5922</RequestId><HostId>Xu30q0VM0aaYY091koYh8FIUDPB2KWOQLRPqnLulIK3ScIrMWgOwF7M2XRYIi5Vs</HostId></Error>'
+    http_version:
+  recorded_at: Sun, 30 Dec 2012 17:59:37 GMT
+- request:
+    method: put
+    uri: https://s3-ap-northeast-1.amazonaws.com/name-of-a-new-bucket
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Date:
+      - Sun, 30 Dec 2012 19:59:37 EET
+      Content-Type:
+      - ''
+      Content-Length:
+      - '0'
+      Authorization:
+      - AWS foo
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - 7HuGyurBPI/HV8DVtjtRufaMaLRJLU+vCch+BPuBAysYAlE7XS4Eavz7srhB2dTx
+      X-Amz-Request-Id:
+      - 431755651DECBBC5
+      Date:
+      - Sun, 30 Dec 2012 17:59:39 GMT
+      Location:
+      - /name-of-a-new-bucket
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Sun, 30 Dec 2012 17:59:39 GMT
+- request:
+    method: put
+    uri: https://s3-ap-northeast-1.amazonaws.com/name-of-a-new-bucket/?website
+    body:
+      encoding: US-ASCII
+      string: ! "\n        <WebsiteConfiguration xmlns='http://s3.amazonaws.com/doc/2006-03-01/'>\n
+        \         <IndexDocument>\n            <Suffix>index.html</Suffix>\n          </IndexDocument>\n
+        \         <ErrorDocument>\n            <Key>error.html</Key>\n          </ErrorDocument>\n
+        \       </WebsiteConfiguration>\n      "
+    headers:
+      Date:
+      - Sun, 30 Dec 2012 19:59:39 EET
+      Content-Type:
+      - ''
+      Content-Length:
+      - '298'
+      Authorization:
+      - AWS foo
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Amz-Id-2:
+      - XZE0T/tWFNuRi6/yu1O+O3A7fJ/j2oas8ZqK4p6rLbaRxevXe44K/pAOsrB381ei
+      X-Amz-Request-Id:
+      - 514396AE3C1BB2C1
+      Date:
+      - Sun, 30 Dec 2012 17:59:41 GMT
+      Content-Length:
+      - '0'
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Sun, 30 Dec 2012 17:59:42 GMT
+- request:
+    method: put
+    uri: https://s3-ap-northeast-1.amazonaws.com/name-of-a-new-bucket/?policy
+    body:
+      encoding: US-ASCII
+      string: ! "{\n        \"Version\":\"2008-10-17\",\n        \"Statement\":[{\n
+        \         \"Sid\":\"PublicReadForGetBucketObjects\",\n          \"Effect\":\"Allow\",\n
+        \         \"Principal\": { \"AWS\": \"*\" },\n          \"Action\":[\"s3:GetObject\"],\n
+        \         \"Resource\":[\"arn:aws:s3:::name-of-a-new-bucket/*\"]\n        }]\n
+        \     }"
+    headers:
+      Date:
+      - Sun, 30 Dec 2012 19:59:42 EET
+      Content-Type:
+      - ''
+      Content-Length:
+      - '289'
+      Authorization:
+      - AWS foo
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      X-Amz-Id-2:
+      - z/XdtqiOW0ihAGadAXwCNCAuE0OLeFisy4TN5e/3OmEI72dQxQjfftyXFSNNwOQN
+      X-Amz-Request-Id:
+      - 82E8EBABB5D150C5
+      Date:
+      - Sun, 30 Dec 2012 17:59:44 GMT
+      Server:
+      - AmazonS3
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Sun, 30 Dec 2012 17:59:44 GMT
+recorded_with: VCR 2.3.0

data/features/configure_bucket.feature

@@ -6,12 +6,30 @@ Feature: configure an S3 bucket to function as a website
     When I run the configure-s3-website command
     Then the output should be
       """
-      Created bucket name-of-a-new-bucket
+      Created bucket name-of-a-new-bucket in the US Standard Region
       Bucket name-of-a-new-bucket now functions as a website
       Bucket name-of-a-new-bucket is now readable to the whole world
 
       """
 
+  @bucket-does-not-exist
+  Scenario: The configuration does not contain the 's3_endpoint' setting
+    Given my config file is in "features/support/sample_config_files/s3_config_with_non-existing_bucket.yml"
+    When I run the configure-s3-website command
+    Then the output should include
+      """
+      Created bucket name-of-a-new-bucket in the US Standard Region
+      """
+
+  @bucket-does-not-exist-in-tokyo
+  Scenario: Create bucket into the Tokyo region
+    Given my config file is in "features/support/sample_config_files/endpoint_tokyo.yml"
+    When I run the configure-s3-website command
+    Then the output should include
+      """
+      Created bucket name-of-a-new-bucket in the Asia Pacific (Tokyo) Region
+      """
+
   @bucket-exists
   Scenario: The bucket already exists
     Given my config file is in "features/support/sample_config_files/s3_config_with_existing_bucket.yml"

data/features/step_definitions/steps.rb

@@ -15,6 +15,10 @@ Then /^the output should be$/ do |expected_console_output|
   @console_output.should eq(expected_console_output)
 end
 
+Then /^the output should include$/ do |expected_console_output|
+  @console_output.should include(expected_console_output)
+end
+
 module Kernel
   require 'stringio'
 

data/features/support/sample_config_files/endpoint_tokyo.yml

@@ -0,0 +1,4 @@
+s3_id: foo
+s3_secret: foo
+s3_bucket: name-of-a-new-bucket
+s3_endpoint: ap-northeast-1

data/features/support/vcr.rb

@@ -7,5 +7,6 @@ end
 
 VCR.cucumber_tags do |t|
   t.tag '@bucket-does-not-exist'
+  t.tag '@bucket-does-not-exist-in-tokyo'
   t.tag '@bucket-exists'
 end

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

@@ -8,5 +8,8 @@ module ConfigureS3Website
 
     def s3_bucket_name
     end
+
+    def s3_endpoint
+    end
   end
 end

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

@@ -19,6 +19,10 @@ module ConfigureS3Website
       @config['s3_bucket']
     end
 
+    def s3_endpoint
+      @config['s3_endpoint']
+    end
+
     private
 
     def parse_config(yaml_file_path)

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

@@ -59,19 +59,30 @@ module ConfigureS3Website
     end
 
     def self.create_bucket(config_source)
+      endpoint = Endpoint.new(config_source.s3_endpoint || '')
+      body = %|
+        <CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+          <LocationConstraint>#{endpoint.location_constraint}</LocationConstraint>
+        </CreateBucketConfiguration >
+      |
       call_s3_api(
         path = "/#{config_source.s3_bucket_name}",
         method = Net::HTTP::Put,
-        body = '',
+        body = body,
         config_source = config_source
       )
-      puts "Created bucket #{config_source.s3_bucket_name}"
+      puts "Created bucket %s in the %s Region" %
+        [
+          config_source.s3_bucket_name,
+          endpoint.region
+        ]
     end
 
     def self.call_s3_api(path, method, body, config_source)
+      endpoint = Endpoint.new(config_source.s3_endpoint || '')
       date = Time.now.strftime("%a, %d %b %Y %H:%M:%S %Z")
       digest = create_digest(path, method, config_source, date)
-      url = "https://s3.amazonaws.com#{path}"
+      url = "https://#{endpoint.hostname}#{path}"
       uri = URI.parse(url)
       req = method.new(uri.to_s)
       req.initialize_http_header({
@@ -104,6 +115,34 @@ end
 
 private
 
+module ConfigureS3Website
+  class Endpoint
+    attr_reader :region, :location_constraint, :hostname
+
+    def initialize(location_constraint)
+      raise InvalidS3LocationConstraintError unless
+        location_constraints.has_key?location_constraint
+      @region = location_constraints.fetch(location_constraint)[:region]
+      @hostname = location_constraints.fetch(location_constraint)[:endpoint]
+      @location_constraint = location_constraint
+    end
+
+    # http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region
+    def location_constraints
+      {
+        ''               => { :region => 'US Standard',                   :endpoint => 's3.amazonaws.com' },
+        'us-west-2'      => { :region => 'US West (Oregon)',              :endpoint => 's3-us-west-2.amazonaws.com' },
+        'us-west-1'      => { :region => 'US West (Northern California)', :endpoint => 's3-us-west-1.amazonaws.com' },
+        'EU'             => { :region => 'EU (Ireland)',                  :endpoint => 's3-eu-west-1.amazonaws.com' },
+        'ap-southeast-1' => { :region => 'Asia Pacific (Singapore)',      :endpoint => 's3-ap-southeast-1.amazonaws.com' },
+        'ap-southeast-2' => { :region => 'Asia Pacific (Sydney)',         :endpoint => 's3-ap-southeast-2.amazonaws.com' },
+        'ap-northeast-1' => { :region => 'Asia Pacific (Tokyo)',          :endpoint => 's3-ap-northeast-1.amazonaws.com' },
+        'sa-east-1'      => { :region => 'South America (Sao Paulo)',     :endpoint => 's3-sa-east-1.amazonaws.com' }
+      }
+    end
+  end
+end
+
 module ConfigureS3Website
   class ErrorParser
     def self.create_error(amazon_error_xml)
@@ -117,6 +156,9 @@ module ConfigureS3Website
   end
 end
 
+class InvalidS3LocationConstraintError < StandardError
+end
+
 class NoSuchBucketError < StandardError
 end
 

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

@@ -1,3 +1,3 @@
 module ConfigureS3Website
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/s3_client_spec.rb

@@ -0,0 +1,18 @@
+require 'rspec'
+require 'configure-s3-website'
+
+describe ConfigureS3Website::S3Client do
+  context '#create_bucket' do
+    let(:config_source) {
+      mock = double('config_source')
+      mock.stub(:s3_endpoint).and_return('invalid-location-constraint')
+      mock
+    }
+    it 'throws an error if the config contains an invalid S3 location constraint' do
+      expect {
+        extractor = ConfigureS3Website::S3Client.
+          send(:create_bucket, config_source)
+      }.to raise_error(InvalidS3LocationConstraintError)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configure-s3-website
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-30 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -138,13 +138,16 @@ files:
 - README.md
 - Rakefile
 - bin/configure-s3-website
+- changelog.md
 - configure-s3-website.gemspec
+- features/cassettes/cucumber_tags/bucket-does-not-exist-in-tokyo.yml
 - features/cassettes/cucumber_tags/bucket-does-not-exist.yml
 - features/cassettes/cucumber_tags/bucket-exists.yml
 - features/config_file.feature
 - features/configure_bucket.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+- features/support/sample_config_files/endpoint_tokyo.yml
 - features/support/sample_config_files/s3_config_with_existing_bucket.yml
 - features/support/sample_config_files/s3_config_with_non-existing_bucket.yml
 - features/support/vcr.rb
@@ -154,6 +157,7 @@ files:
 - lib/configure-s3-website/s3_client.rb
 - lib/configure-s3-website/version.rb
 - spec/config_extractor/file_config_extractor_spec.rb
+- spec/s3_client_spec.rb
 - spec/sample_files/_config_file_with_eruby.yml
 homepage: https://github.com/laurilehmijoki/configure-s3-website
 licenses: []
@@ -178,16 +182,19 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Configure your S3 bucket to function as a web site
+summary: Configure your AWS S3 bucket to function as a web site
 test_files:
+- features/cassettes/cucumber_tags/bucket-does-not-exist-in-tokyo.yml
 - features/cassettes/cucumber_tags/bucket-does-not-exist.yml
 - features/cassettes/cucumber_tags/bucket-exists.yml
 - features/config_file.feature
 - features/configure_bucket.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+- features/support/sample_config_files/endpoint_tokyo.yml
 - features/support/sample_config_files/s3_config_with_existing_bucket.yml
 - features/support/sample_config_files/s3_config_with_non-existing_bucket.yml
 - features/support/vcr.rb
 - spec/config_extractor/file_config_extractor_spec.rb
+- spec/s3_client_spec.rb
 - spec/sample_files/_config_file_with_eruby.yml