configure-s3-website 1.7.3 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f6972f08379371509616f8749054228cd210ae9
-  data.tar.gz: 0af5ebe8a97271862fa888332bb97a3213ca7e3a
+  metadata.gz: 1520dfada65dc18e62434f4374df69305fc87b01
+  data.tar.gz: 65ca8ec93209289f9039628f3db2ae40f9306267
 SHA512:
-  metadata.gz: c598441c45d35f9137da165ecbc67889f3f5e0c9be906d9eb2bfca82db810dc8d5fa62b619870d72b0598efe6800fdc0a3483a44b2cab8d2d419f7be84cb888a
-  data.tar.gz: d6aea64ea95f47f46781663078e398ff053b7ab988bd0fb05dd91feb291d24e1bfd501675f66d730174be0d1130b3e3f1f5ba3086062fade14d13761a4c3e60d
+  metadata.gz: c86f7290d8c4f61887eb05d8b0d1a623b8031ef279879d503277231beae3983ac64a9b763ecd740cb8bbd4395a6317921021b51341ab82577827794e60509f46
+  data.tar.gz: 5b0d6d7a2bcf29909210afbd006facb81519a770ebae665bad370528a8bde4886e5565a838401c7c0dafb2b0c912f18fc615f91d06fb5fc3bb82b0f9ea04f665

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-- 1.9.3
-- 2.0.0
 - 2.1.0
+- 2.2.0
+- 2.3.0

data/Rakefile

@@ -7,10 +7,5 @@ task :default => 'test'
 desc "Run tests"
 task :test do
   sh "bundle exec rspec"
-  sh "bundle exec cucumber"
 end
 
-desc 'Run features tagged with @wip'
-task 'cucumber:wip' do
-  sh "bundle exec cucumber --tags @wip"
-end

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 1.7.4
+
+* Support all AWS regions
+
 ## 1.7.3
 
 * see <https://github.com/laurilehmijoki/configure-s3-website/pull/13>

data/configure-s3-website.gemspec

@@ -10,18 +10,14 @@ spec = Gem::Specification.new do |s|
   s.bindir = 'bin'
 
   s.add_dependency 'deep_merge', '~> 1.0.0'
+  s.add_dependency 'aws-sdk', '~> 2'
 
-  s.add_development_dependency 'rspec', '~> 2.10.0'
-  s.add_development_dependency 'rspec-expectations', '~> 2.10.0'
-  s.add_development_dependency 'cucumber', '~> 1.2.0'
-  s.add_development_dependency 'aruba', '~> 0.4.0'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rspec-expectations', '~> 3'
   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")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/lib/configure-s3-website.rb

@@ -3,6 +3,7 @@ require 'configure-s3-website/s3_client'
 require 'configure-s3-website/cloudfront_client'
 require 'configure-s3-website/xml_helper'
 require 'configure-s3-website/http_helper'
+require 'configure-s3-website/endpoint_helper'
 require 'configure-s3-website/runner'
 require 'configure-s3-website/cli'
 require 'configure-s3-website/config_source/config_source'

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

@@ -113,7 +113,7 @@ module ConfigureS3Website
     end
 
     def self.distribution_config_xml(config_source, custom_cf_settings)
-      domain_name = "#{config_source.s3_bucket_name}.#{Endpoint.by_config_source(config_source).website_hostname}"
+      domain_name = "#{config_source.s3_bucket_name}.#{EndpointHelper.s3_website_hostname(config_source.s3_endpoint)}"
       %|
       <DistributionConfig xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
         <Origins>

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

@@ -25,7 +25,12 @@ module ConfigureS3Website
     end
 
     def s3_endpoint
-      @config['s3_endpoint']
+      endpoint = @config['s3_endpoint'] || 'us-east-1'
+      if endpoint == 'EU'
+        'eu-west-1'
+      else
+        endpoint
+      end
     end
 
     def routing_rules

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

@@ -0,0 +1,26 @@
+module ConfigureS3Website
+  class EndpointHelper
+    def self.s3_website_hostname(region)
+      if old_regions.include?(region)
+        "s3-website-#{region}.amazonaws.com"
+      else
+        "s3-website.#{region}.amazonaws.com"
+      end
+    end
+
+    private
+
+    def self.old_regions
+      [
+        'us-east-1',
+        'us-west-1',
+        'us-west-2',
+        'ap-southeast-1',
+        'ap-southeast-2',
+        'ap-northeast-1',
+        'eu-west-1',
+        'sa-east-1'
+      ]
+    end
+  end
+end

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

@@ -1,20 +1,5 @@
 module ConfigureS3Website
   class HttpHelper
-    def self.call_s3_api(path, method, body, config_source)
-      endpoint = Endpoint.by_config_source(config_source)
-      date = Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S %Z")
-      digest = create_s3_digest(path, method, config_source, date)
-      self.call_api(
-        path,
-        method,
-        body,
-        config_source,
-        endpoint.hostname,
-        digest,
-        date
-      )
-    end
-
     def self.call_cloudfront_api(path, method, body, config_source, headers = {})
       date = Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S %Z")
       digest = create_cloudfront_digest(config_source, date)
@@ -55,14 +40,6 @@ module ConfigureS3Website
       end
     end
 
-    def self.create_s3_digest(path, method, config_source, date)
-      digest = OpenSSL::Digest.new('sha1')
-      method_string = method.to_s.match(/Net::HTTP::(\w+)/)[1].upcase
-      can_string = "#{method_string}\n\n\n#{date}\n#{path}"
-      hmac = OpenSSL::HMAC.digest(digest, config_source.s3_secret_access_key, can_string)
-      signature = Base64.encode64(hmac).strip
-    end
-
     def self.create_cloudfront_digest(config_source, date)
       digest = Base64.encode64(
         OpenSSL::HMAC.digest(

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

@@ -3,6 +3,7 @@ require 'openssl'
 require 'digest/sha1'
 require 'digest/md5'
 require 'net/https'
+require 'aws-sdk'
 
 module ConfigureS3Website
   class S3Client
@@ -11,8 +12,7 @@ module ConfigureS3Website
       begin
         enable_website_configuration(config_source)
         make_bucket_readable_to_everyone(config_source)
-        configure_bucket_redirects(config_source)
-      rescue NoSuchBucketError
+      rescue Aws::S3::Errors::NoSuchBucket
         create_bucket(config_source)
         retry
       end
@@ -20,157 +20,91 @@ module ConfigureS3Website
 
     private
 
-    def self.enable_website_configuration(config_source)
-      body = %|
-        <WebsiteConfiguration xmlns='http://s3.amazonaws.com/doc/2006-03-01/'>
-          <IndexDocument>
-            <Suffix>#{config_source.index_document || "index.html"}</Suffix>
-          </IndexDocument>
-          <ErrorDocument>
-            <Key>#{config_source.error_document || "error.html"}</Key>
-          </ErrorDocument>
-        </WebsiteConfiguration>
-      |
-      HttpHelper.call_s3_api(
-        path = "/#{config_source.s3_bucket_name}/?website",
-        method = Net::HTTP::Put,
-        body = body,
-        config_source = config_source
-      )
-      puts "Bucket #{config_source.s3_bucket_name} now functions as a website"
-    end
-
-    def self.make_bucket_readable_to_everyone(config_source)
-      policy_json = %|{
-        "Version":"2008-10-17",
-        "Statement":[{
-          "Sid":"PublicReadForGetBucketObjects",
-          "Effect":"Allow",
-          "Principal": { "AWS": "*" },
-          "Action":["s3:GetObject"],
-          "Resource":["arn:aws:s3:::#{config_source.s3_bucket_name}/*"]
-        }]
-      }|
-      HttpHelper.call_s3_api(
-        path = "/#{config_source.s3_bucket_name}/?policy",
-        method = Net::HTTP::Put,
-        body = policy_json,
-        config_source = config_source
+    def self.s3(config_source)
+      s3 = Aws::S3::Client.new(
+        region: config_source.s3_endpoint,
+        access_key_id: config_source.s3_access_key_id,
+        secret_access_key: config_source.s3_secret_access_key
       )
-      puts "Bucket #{config_source.s3_bucket_name} is now readable to the whole world"
     end
 
-    def self.configure_bucket_redirects(config_source)
-      routing_rules = config_source.routing_rules
-      if routing_rules.is_a?(Array) && routing_rules.any?
-        body = %|
-          <WebsiteConfiguration xmlns='http://s3.amazonaws.com/doc/2006-03-01/'>
-            <IndexDocument>
-              <Suffix>#{config_source.index_document || "index.html"}</Suffix>
-            </IndexDocument>
-            <ErrorDocument>
-              <Key>#{config_source.error_document || "error.html"}</Key>
-            </ErrorDocument>
-            <RoutingRules>
-        |
-        routing_rules.each do |routing_rule|
-          body << %|
-              <RoutingRule>
-          |
-          body << XmlHelper.hash_to_api_xml(routing_rule, 7)
-          body << %|
-              </RoutingRule>
-          |
+    def self.enable_website_configuration(config_source)
+      routing_rules =
+        if config_source.routing_rules && config_source.routing_rules.is_a?(Array)
+          config_source.routing_rules.map { |rule|
+            Hash[
+              rule.map { |rule_key, rule_value|
+                [
+                  rule_key.to_sym,
+                  Hash[ # Assume that each rule value is a Hash
+                    rule_value.map { |redirect_rule_key, redirect_rule_value|
+                      [
+                        redirect_rule_key.to_sym,
+                        redirect_rule_key == "http_redirect_code" ?
+                          redirect_rule_value.to_s
+                          #redirect_rule_value.to_s  # Permit numeric redirect values in the YAML config file. (The S3 API does not allow numeric redirect values, hence this block of code.)
+                          :
+                          redirect_rule_value
+                      ]
+                    }
+                  ]
+                ]
+              }
+            ]
+          }
+        else
+          nil
         end
-        body << %|
-            </RoutingRules>
-          </WebsiteConfiguration>
-        |
-
-        HttpHelper.call_s3_api(
-          path = "/#{config_source.s3_bucket_name}/?website",
-          method = Net::HTTP::Put,
-          body = body,
-          config_source = config_source
-        )
+      s3(config_source).put_bucket_website({
+        bucket: config_source.s3_bucket_name,
+        website_configuration: {
+          index_document: {
+            suffix: config_source.index_document || "index.html"
+          },
+          error_document: {
+            key: config_source.error_document || "error.html"
+          },
+          routing_rules: routing_rules
+        }
+      })
+      puts "Bucket #{config_source.s3_bucket_name} now functions as a website"
+      if routing_rules && routing_rules.any?
         puts "#{routing_rules.size} redirects configured for #{config_source.s3_bucket_name} bucket"
       else
         puts "No redirects to configure for #{config_source.s3_bucket_name} bucket"
       end
     end
 
-    def self.create_bucket(config_source)
-      endpoint = Endpoint.new(config_source.s3_endpoint || '')
-      body = if endpoint.region == 'US Standard'
-               '' # The standard endpoint does not need a location constraint
-             else
-        %|
-          <CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
-            <LocationConstraint>#{endpoint.location_constraint}</LocationConstraint>
-          </CreateBucketConfiguration >
-         |
-             end
+    def self.make_bucket_readable_to_everyone(config_source)
+      s3(config_source).put_bucket_policy({
+        bucket: config_source.s3_bucket_name,
+        policy: %|{
+          "Version":"2008-10-17",
+          "Statement":[{
+            "Sid":"PublicReadForGetBucketObjects",
+            "Effect":"Allow",
+            "Principal": { "AWS": "*" },
+            "Action":["s3:GetObject"],
+            "Resource":["arn:aws:s3:::#{config_source.s3_bucket_name}/*"]
+          }]
+        }|
+      })
+      puts "Bucket #{config_source.s3_bucket_name} is now readable to the whole world"
+    end
 
-      HttpHelper.call_s3_api(
-        path = "/#{config_source.s3_bucket_name}",
-        method = Net::HTTP::Put,
-        body = body,
-        config_source = config_source
-      )
+    def self.create_bucket(config_source)
+      s3(config_source).create_bucket({
+        bucket: config_source.s3_bucket_name,
+        create_bucket_configuration: {
+          location_constraint: config_source.s3_endpoint
+        }
+      })
       puts "Created bucket %s in the %s Region" %
         [
           config_source.s3_bucket_name,
-          endpoint.region
+          config_source.s3_endpoint
         ]
     end
   end
 end
 
-private
-
-module ConfigureS3Website
-  class Endpoint
-    attr_reader :region, :location_constraint, :hostname, :website_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]
-      @website_hostname = location_constraints.fetch(location_constraint)[:website_endpoint]
-      @location_constraint = location_constraint
-    end
-
-    # http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region
-    def location_constraints
-      eu_west_1_region = {
-        :region           => 'EU (Ireland)',
-        :website_endpoint => 's3-website-eu-west-1.amazonaws.com',
-        :endpoint         => 's3-eu-west-1.amazonaws.com'
-      }
-
-      {
-        ''               => { :region => 'US Standard',                   :endpoint => 's3.amazonaws.com',                :website_endpoint => 's3-website-us-east-1.amazonaws.com' },
-        'us-west-2'      => { :region => 'US West (Oregon)',              :endpoint => 's3-us-west-2.amazonaws.com',      :website_endpoint => 's3-website-us-west-2.amazonaws.com' },
-        'us-west-1'      => { :region => 'US West (Northern California)', :endpoint => 's3-us-west-1.amazonaws.com',      :website_endpoint => 's3-website-us-west-1.amazonaws.com' },
-        'EU'             => eu_west_1_region,
-        'eu-west-1'      => eu_west_1_region,
-        'eu-central-1'   => { :region => 'EU (Frankfurt)',                :endpoint => 's3.eu-central-1.amazonaws.com',   :website_endpoint => 's3-website.eu-central-1.amazonaws.com' },
-        'ap-southeast-1' => { :region => 'Asia Pacific (Singapore)',      :endpoint => 's3-ap-southeast-1.amazonaws.com', :website_endpoint => 's3-website-ap-southeast-1.amazonaws.com' },
-        'ap-southeast-2' => { :region => 'Asia Pacific (Sydney)',         :endpoint => 's3-ap-southeast-2.amazonaws.com', :website_endpoint => 's3-website-ap-southeast-2.amazonaws.com' },
-        'ap-northeast-1' => { :region => 'Asia Pacific (Tokyo)',          :endpoint => 's3-ap-northeast-1.amazonaws.com', :website_endpoint => 's3-website-ap-northeast-1.amazonaws.com' },
-        'sa-east-1'      => { :region => 'South America (Sao Paulo)',     :endpoint => 's3-sa-east-1.amazonaws.com',      :website_endpoint => 's3-website-sa-east-1.amazonaws.com' }
-      }
-    end
-
-    def self.by_config_source(config_source)
-      endpoint = Endpoint.new(config_source.s3_endpoint || '')
-    end
-  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.7.3'
+  VERSION = '1.7.4'
 end

data/spec/cloudfront_client_spec.rb

@@ -8,8 +8,8 @@ describe ConfigureS3Website::CloudFrontClient do
     describe 'letting the user to override the default values' do
       let(:config_source) {
         mock = double('config_source')
-        mock.stub(:s3_bucket_name).and_return('test-bucket')
-        mock.stub(:s3_endpoint).and_return(nil)
+        allow(mock).to receive(:s3_bucket_name).and_return('test-bucket')
+        allow(mock).to receive(:s3_endpoint).and_return(nil)
         mock
       }
 
@@ -28,44 +28,61 @@ describe ConfigureS3Website::CloudFrontClient do
       }
 
       it 'allows the user to override default CloudFront settings' do
-        REXML::XPath.first(
+        expect(REXML::XPath.first(
           distribution_config_xml,
           '/DistributionConfig/DefaultCacheBehavior/MinTTL'
-        ).get_text.to_s.should eq('987')
+        ).get_text.to_s).to eq('987')
       end
 
       it 'retains the default values that are not overriden' do
-        REXML::XPath.first(
+        expect(REXML::XPath.first(
           distribution_config_xml,
           '/DistributionConfig/DefaultCacheBehavior/ViewerProtocolPolicy'
-        ).get_text.to_s.should eq('allow-all')
+        ).get_text.to_s).to eq('allow-all')
       end
     end
 
-    describe 'inferring //Origins/Items/Origin/DomainName' do
-      let(:config_source) {
-        mock = double('config_source')
-        mock.stub(:s3_bucket_name).and_return('test-bucket')
-        mock.stub(:s3_endpoint).and_return('us-west-1')
-        mock
-      }
+    [
+      { :region => 'us-east-1', :website_endpoint => 's3-website-us-east-1.amazonaws.com' },
+      { :region => 'us-west-1', :website_endpoint => 's3-website-us-west-1.amazonaws.com' },
+      { :region => 'us-west-2', :website_endpoint => 's3-website-us-west-2.amazonaws.com' },
+      { :region => 'ap-south-1', :website_endpoint => 's3-website.ap-south-1.amazonaws.com' },
+      { :region => 'ap-northeast-2', :website_endpoint => 's3-website.ap-northeast-2.amazonaws.com' },
+      { :region => 'ap-southeast-1', :website_endpoint => 's3-website-ap-southeast-1.amazonaws.com' },
+      { :region => 'ap-southeast-2', :website_endpoint => 's3-website-ap-southeast-2.amazonaws.com' },
+      { :region => 'ap-northeast-1', :website_endpoint => 's3-website-ap-northeast-1.amazonaws.com' },
+      { :region => 'eu-central-1', :website_endpoint => 's3-website.eu-central-1.amazonaws.com' },
+      { :region => 'eu-west-1', :website_endpoint => 's3-website-eu-west-1.amazonaws.com' },
+      { :region => 'sa-east-1', :website_endpoint => 's3-website-sa-east-1.amazonaws.com' },
+    ].each { |conf|
+      region = conf[:region]
+      website_endpoint = conf[:website_endpoint]
+      describe "inferring //Origins/Items/Origin/DomainName (#{region})" do
+        let(:config_source) {
+          mock = double('config_source')
+          allow(mock).to receive(:s3_bucket_name).and_return('test-bucket')
+          allow(mock).to receive(:s3_endpoint).and_return(region)
+          mock
+        }
 
-      let(:distribution_config_xml) {
-        REXML::Document.new(
-          ConfigureS3Website::CloudFrontClient.send(
-            :distribution_config_xml,
-            config_source,
-            custom_distribution_config = {}
+        let(:distribution_config_xml) {
+          REXML::Document.new(
+            ConfigureS3Website::CloudFrontClient.send(
+              :distribution_config_xml,
+              config_source,
+              custom_distribution_config = {}
+            )
           )
-        )
-      }
+        }
 
-      it 'honors the endpoint of the S3 website' do
-        REXML::XPath.first(
-          distribution_config_xml,
-          '/DistributionConfig/Origins/Items/Origin/DomainName'
-        ).get_text.to_s.should eq('test-bucket.s3-website-us-west-1.amazonaws.com')
+        it "honors the endpoint of the S3 website (#{region})" do
+          expect(REXML::XPath.first(
+            distribution_config_xml,
+            '/DistributionConfig/Origins/Items/Origin/DomainName'
+          ).get_text.to_s).to eq("test-bucket.#{website_endpoint}")
+        end
       end
-    end
+    }
+
   end
 end