configure-s3-website 1.7.5 → 2.0.0.pre.RC1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 772c1776d6327d9b5f05962dc98c2db3993efbd8
-  data.tar.gz: 941789187e3608cdb2e7ab0a878ab8d06ea6818d
+  metadata.gz: 4eb8cd23cd38b0f3330c3917994b6d2ebfff0b0d
+  data.tar.gz: d94e2faca53f693abc671f839b8ac4b8525119fc
 SHA512:
-  metadata.gz: b5031cd1225cde3d2c30988ca8588f0b10ca9b67a115d1cb3c7ff2bda2405533f22638a15eac1f428dc05d1f6f8799f8f2445d412fb37fe04a1f981b96171850
-  data.tar.gz: 576061e3ca1fcb50e24af52dc9d924c8fee08082d0a9035e456cd10fb35cbbfbd21d4261760e6330c8d16a4e490b27e9c15c46dd1cf95370cc5aaa17f3c58255
+  metadata.gz: 2432f7a98b9c751a920037c54e015a48a096fffc36aaff2713b1b63e1a1f8232a58a0ed918e35327619d23bbe77a668eb92b60f9187838b5d1e782078ae5f3a7
+  data.tar.gz: b66e343138433203ec72d781d286c10d374ab560860c39419c556ba75b9ccdb84527ddcfcd8e92d565dea326d6b6da66d4b0754959a2b1c08e179d65b64a04fd

data/changelog.md

@@ -2,6 +2,40 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## Next
+
+### Breaking changes
+
+Since the CloudFront integration now uses the official Ruby AWS SDK, the
+accepted format of the `cloudfront_distribution_config` is slightly different.
+
+Below are some examples of changes that you have to perform, depending on the
+contents of your `cloudfront_distribution_config` setting.
+
+* Rename `min_TTL` -> `min_ttl`
+* Change
+
+    ```yaml
+    aliases:
+      quantity: 1
+      items:
+        CNAME: my.site.net
+    ```
+
+    to
+
+    ```yaml
+    aliases:
+      quantity: 1
+      items:
+        - my.site.net
+    ```
+
+* There might be other incompatible settings in your old configuration, but
+  should them exist, the AWS SDK client will print you a helpful error and then
+  safely exit. If this happens, just fix the problems that client reports and
+  try again.
+
 ## 1.7.5
 
 * Fix CreateBucket broken in 1.7.4

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

@@ -1,5 +1,5 @@
-require "rexml/document"
-require "rexml/xpath"
+require "aws-sdk"
+require 'deep_merge'
 
 module ConfigureS3Website
   class CloudFrontClient
@@ -7,40 +7,28 @@ module ConfigureS3Website
       config_source = options[:config_source]
       puts "Detected an existing CloudFront distribution (id #{config_source.cloudfront_distribution_id}) ..."
 
-      # Get caller reference and ETag (will be required by the PUT config resource)
-      response = HttpHelper.call_cloudfront_api(
-        path = "/2012-07-01/distribution/#{config_source.cloudfront_distribution_id}/config",
-        method = Net::HTTP::Get,
-        body = '',
-        config_source
-      )
-      etag = response['ETag']
-      caller_reference = REXML::XPath.first(
-        REXML::Document.new(response.body),
-        '/DistributionConfig/CallerReference'
-      ).get_text.to_s
+      live_config = cloudfront(config_source).get_distribution({
+        id: options[:config_source].cloudfront_distribution_id
+      })
 
-      # Call the PUT config resource with the caller reference and ETag
       custom_distribution_config = config_source.cloudfront_distribution_config || {}
-      custom_distribution_config_with_caller_ref = custom_distribution_config.merge({
-        'caller_reference' => caller_reference,
-        'comment' => 'Updated by the configure-s3-website gem'
-      })
-      HttpHelper.call_cloudfront_api(
-        path = "/2012-07-01/distribution/#{options[:config_source].cloudfront_distribution_id}/config",
-        method = Net::HTTP::Put,
-        body = distribution_config_xml(
-          config_source,
-          custom_distribution_config_with_caller_ref
-        ),
-        config_source,
-        headers = { 'If-Match' => etag }
+      if custom_distribution_config.empty?
+        return
+      end
+      live_distribution_config = live_config.distribution.distribution_config.to_hash
+      custom_distribution_config_with_caller_ref = live_distribution_config.deep_merge!(
+        deep_symbolize(custom_distribution_config.merge({
+          caller_reference: live_config.distribution.distribution_config.caller_reference,
+          comment: 'Updated by the configure-s3-website gem'
+        }))
       )
+      cloudfront(config_source).update_distribution({
+        distribution_config: custom_distribution_config_with_caller_ref,
+        id: options[:config_source].cloudfront_distribution_id,
+        if_match: live_config.etag
+      })
 
-      # Report
-      unless custom_distribution_config.empty?
-        print_report_on_custom_distribution_config custom_distribution_config
-      end
+      print_report_on_custom_distribution_config custom_distribution_config_with_caller_ref
     end
 
     def self.create_distribution_if_user_agrees(options, standard_input)
@@ -59,19 +47,22 @@ module ConfigureS3Website
 
     private
 
+    def self.cloudfront(config_source)
+      Aws::CloudFront::Client.new(
+        region: 'us-east-1',
+        access_key_id: config_source.s3_access_key_id,
+        secret_access_key: config_source.s3_secret_access_key
+      )
+    end
+
     def self.create_distribution(options)
       config_source = options[:config_source]
       custom_distribution_config = config_source.cloudfront_distribution_config || {}
-      response_xml = REXML::Document.new(
-        HttpHelper.call_cloudfront_api(
-          '/2012-07-01/distribution',
-          Net::HTTP::Post,
-          distribution_config_xml(config_source, custom_distribution_config),
-          config_source
-        ).body
-      )
-      dist_id = REXML::XPath.first(response_xml, '/Distribution/Id').get_text
-      print_report_on_new_dist response_xml, dist_id, options, config_source
+      distribution = cloudfront(config_source).create_distribution(
+        deep_symbolize new_distribution_config(config_source, custom_distribution_config)
+      ).distribution
+      dist_id = distribution.id
+      print_report_on_new_dist distribution, dist_id, options, config_source
       config_source.cloudfront_distribution_id = dist_id.to_s
       puts "  Added setting 'cloudfront_distribution_id: #{dist_id}' into #{config_source.description}"
       unless custom_distribution_config.empty?
@@ -88,96 +79,67 @@ module ConfigureS3Website
         gsub(/^/, padding(left_padding))
     end
 
-    def self.print_report_on_new_dist(response_xml, dist_id, options, config_source)
+    def self.print_report_on_new_dist(distribution, dist_id, options, config_source)
       config_source = options[:config_source]
-      dist_domain_name = REXML::XPath.first(response_xml, '/Distribution/DomainName').get_text
-      s3_website_domain_name = REXML::XPath.first(
-        response_xml,
-        '/Distribution/DistributionConfig/Origins/Items/Origin/DomainName'
-      ).get_text
-      puts "  The distribution #{dist_id} at #{dist_domain_name} now delivers the origin #{s3_website_domain_name}"
+      puts "  The distribution #{dist_id} at #{distribution.domain_name} now delivers the origin #{distribution.distribution_config.origins.items[0].domain_name}"
       puts '    Please allow up to 15 minutes for the distribution to initialise'
       puts '    For more information on the distribution, see https://console.aws.amazon.com/cloudfront'
       if options[:verbose]
         puts '  Below is the response from the CloudFront API:'
-        print_verbose_response_from_cloudfront(response_xml)
+        puts distribution
       end
     end
 
-    def self.print_verbose_response_from_cloudfront(response_xml, left_padding = 4)
-      lines = []
-      response_xml.write(lines, 2)
-      puts lines.join().
-        gsub(/^/, "" + padding(left_padding)).
-        gsub(/\s$/, "")
-    end
-
-    def self.distribution_config_xml(config_source, custom_cf_settings)
-      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>
-          <Quantity>1</Quantity>
-          <Items>
-            <Origin>
-              <Id>#{origin_id config_source}</Id>
-              <DomainName>#{domain_name}</DomainName>
-              <CustomOriginConfig>
-                <HTTPPort>80</HTTPPort>
-                <HTTPSPort>443</HTTPSPort>
-                <OriginProtocolPolicy>http-only</OriginProtocolPolicy>
-              </CustomOriginConfig>
-            </Origin>
-          </Items>
-        </Origins>
-        #{
-          require 'deep_merge'
-          settings = default_cloudfront_settings config_source
-          settings.deep_merge! custom_cf_settings
-          XmlHelper.hash_to_api_xml(settings)
-        }
-      </DistributionConfig>
-      |
-    end
-
-    # Changing these default settings probably necessitates a
-    # backward incompatible release.
-    #
-    # If you change these settings, remember to update also the README.md.
-    def self.default_cloudfront_settings(config_source)
+    def self.new_distribution_config(config_source, custom_cf_settings)
       {
-        'caller_reference' => 'configure-s3-website gem ' + Time.now.to_s,
-        'default_root_object' => 'index.html',
-        'logging' => {
-          'enabled' => 'false',
-          'include_cookies' => 'false',
-          'bucket' => '',
-          'prefix' => ''
-        },
-        'enabled' => 'true',
-        'comment' => 'Created by the configure-s3-website gem',
-        'aliases' => {
-          'quantity' => '0'
-        },
-        'default_cache_behavior' => {
-          'target_origin_id' => (origin_id config_source),
-          'trusted_signers' => {
+        'distribution_config' => {
+          'caller_reference' => 'configure-s3-website gem ' + Time.now.to_s,
+          'default_root_object' => 'index.html',
+          'origins' => {
+            'quantity' => 1,
+            'items' => [
+              {
+                'id' => (origin_id config_source),
+                'domain_name' => "#{config_source.s3_bucket_name}.#{EndpointHelper.s3_website_hostname(config_source.s3_endpoint)}",
+                'custom_origin_config' => {
+                  'http_port' => 80,
+                  'https_port' => 443,
+                  'origin_protocol_policy' => 'http-only'
+                }
+              }
+            ]
+          },
+          'logging' => {
             'enabled' => 'false',
+            'include_cookies' => 'false',
+            'bucket' => '',
+            'prefix' => ''
+          },
+          'enabled' => 'true',
+          'comment' => 'Created by the configure-s3-website gem',
+          'aliases' => {
             'quantity' => '0'
           },
-          'forwarded_values' => {
-            'query_string' => 'true',
-            'cookies' => {
-              'forward' => 'all'
-            }
+          'default_cache_behavior' => {
+            'target_origin_id' => (origin_id config_source),
+            'trusted_signers' => {
+              'enabled' => 'false',
+              'quantity' => '0'
+            },
+            'forwarded_values' => {
+              'query_string' => 'true',
+              'cookies' => {
+                'forward' => 'all'
+              }
+            },
+            'viewer_protocol_policy' => 'allow-all',
+            'min_ttl' => '86400'
           },
-          'viewer_protocol_policy' => 'allow-all',
-          'min_TTL' => '86400'
-        },
-        'cache_behaviors' => {
-          'quantity' => '0'
-        },
-        'price_class' => 'PriceClass_All'
+          'cache_behaviors' => {
+            'quantity' => '0'
+          },
+          'price_class' => 'PriceClass_All'
+        }.deep_merge!(custom_cf_settings)
       }
     end
 
@@ -190,5 +152,15 @@ module ConfigureS3Website
       amount.times { padding << " " }
       padding
     end
+
+    def self.deep_symbolize(value)
+      if value.is_a? Hash
+        Hash[value.map { |k,v| [k.to_sym, deep_symbolize(v)] }]
+      elsif value.is_a? Array
+        value.map { |v| deep_symbolize(v) }
+      else
+        value
+      end
+    end
   end
 end

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

@@ -1,3 +1,3 @@
 module ConfigureS3Website
-  VERSION = '1.7.5'
+  VERSION = '2.0.0-RC1'
 end

data/spec/cloudfront_client_spec.rb

@@ -1,88 +1,138 @@
 require 'rspec'
 require 'configure-s3-website'
-require "rexml/document"
-require "rexml/xpath"
 
 describe ConfigureS3Website::CloudFrontClient do
-  context '#distribution_config_xml' do
-    describe 'letting the user to override the default values' 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(nil)
-        mock
-      }
+  RSpec::Matchers.define :lambda_matcher do |lmbda, expected_value|
+    match { |create_distribution_args|
+      lmbda.call(create_distribution_args) == expected_value
+    }
+  end
 
-      let(:custom_settings) {
-        { 'default_cache_behavior' => { 'min_TTL' => '987' } }
-      }
+  def config_source_mock(cloudfront_distribution_config, region)
+    mock = double('config_source')
+    allow(mock).to receive(:s3_bucket_name).and_return('test-bucket')
+    allow(mock).to receive(:s3_endpoint).and_return(region)
+    allow(mock).to receive(:s3_access_key_id).and_return('foo')
+    allow(mock).to receive(:s3_secret_access_key).and_return('bar')
+    allow(mock).to receive(:cloudfront_distribution_id).and_return('AEEEE')
+    allow(mock).to receive(:cloudfront_distribution_id=).with(anything).and_return(nil)
+    allow(mock).to receive(:description)
+    allow(mock).to receive(:cloudfront_distribution_config).and_return(cloudfront_distribution_config)
+    mock
+  end
 
-      let(:distribution_config_xml) {
-        REXML::Document.new(
-          ConfigureS3Website::CloudFrontClient.send(
-            :distribution_config_xml,
-            config_source,
-            custom_settings
-          )
-        )
+  let(:aws_cloudfront_client) {
+    cloudfront_client = double('cloudfront_client')
+    create_distribution_response = double('create_dist_response')
+    allow(create_distribution_response).to receive_message_chain(:distribution, :id) { 'bar' }
+    allow(create_distribution_response).to receive_message_chain(:distribution, :domain_name) { 'foo' }
+    allow(create_distribution_response).to receive_message_chain(:distribution, :distribution_config, :origins, :items) {
+      [double( :domain_name => 'foo' )]
+    }
+    allow(cloudfront_client).to receive(:create_distribution).and_return(create_distribution_response)
+    get_distribution_response = double('get_distribution_response')
+    allow(get_distribution_response).to receive(:etag).and_return('tag')
+    allow(get_distribution_response).to receive_message_chain(:distribution, :distribution_config).and_return({
+      :default_cache_behavior => {
+        :viewer_protocol_policy => 'allow_all',
+        :min_ttl => 5000
+      }
+    })
+    allow(get_distribution_response).to receive_message_chain(:distribution, :distribution_config, :caller_reference) { 'ref' }
+    allow(cloudfront_client).to receive(:get_distribution).with(:id => 'AEEEE').and_return(get_distribution_response)
+    cloudfront_client
+  }
+  before {
+    allow(ConfigureS3Website::CloudFrontClient).to receive(:cloudfront).and_return(aws_cloudfront_client)
+  }
+  describe 'letting the user to override the default values' do
+    cloudfront_distribution_config = {
+      'default_cache_behavior' => {
+        'min_ttl' => 900
       }
+    }
 
-      it 'allows the user to override default CloudFront settings' do
-        expect(REXML::XPath.first(
-          distribution_config_xml,
-          '/DistributionConfig/DefaultCacheBehavior/MinTTL'
-        ).get_text.to_s).to eq('987')
+    context "update distribution" do
+      it "let's the user to override the default ttl" do
+        expect(aws_cloudfront_client).to receive(:update_distribution).with(
+          lambda_matcher(lambda { |update_distribution_args|
+            update_distribution_args[:distribution_config][:default_cache_behavior][:min_ttl]
+          }, 900)
+        )
+        ConfigureS3Website::CloudFrontClient.send(
+          :apply_distribution_config,
+          {:config_source => config_source_mock(cloudfront_distribution_config, region = 'something') }
+        )
       end
 
       it 'retains the default values that are not overriden' do
-        expect(REXML::XPath.first(
-          distribution_config_xml,
-          '/DistributionConfig/DefaultCacheBehavior/ViewerProtocolPolicy'
-        ).get_text.to_s).to eq('allow-all')
+        expect(aws_cloudfront_client).to receive(:update_distribution).with(
+          lambda_matcher(lambda { |update_distribution_args|
+            update_distribution_args[:distribution_config][:default_cache_behavior][:viewer_protocol_policy]
+          }, 'allow_all')
+        )
+        ConfigureS3Website::CloudFrontClient.send(
+          :apply_distribution_config,
+          {:config_source => config_source_mock(cloudfront_distribution_config, region = 'something') }
+        )
       end
     end
 
-    [
-      { :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 = {}
-            )
-          )
-        }
-
-        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
+    context "create distribution" do
+      it "let's the user to override the default ttl" do
+        expect(aws_cloudfront_client).to receive(:create_distribution).with(
+          lambda_matcher(lambda { |create_distribution_args|
+            create_distribution_args[:distribution_config][:default_cache_behavior][:min_ttl]
+          }, 900)
+        )
+        ConfigureS3Website::CloudFrontClient.send(
+          :create_distribution,
+          {:config_source => config_source_mock(cloudfront_distribution_config, region = 'something') }
+        )
       end
-    }
 
+      it 'retains the default values that are not overriden' do
+        expect(aws_cloudfront_client).to receive(:create_distribution).with(
+          lambda_matcher(lambda { |create_distribution_args|
+            create_distribution_args[:distribution_config][:default_cache_behavior][:viewer_protocol_policy]
+          }, 'allow-all')
+        )
+        ConfigureS3Website::CloudFrontClient.send(
+          :create_distribution,
+          {:config_source => config_source_mock(cloudfront_distribution_config, region = 'something') }
+        )
+      end
+    end
   end
+
+  [
+    { :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 "create distribution in #{region}" do
+      it "honors the endpoint of the S3 website (#{region})" do
+        expect(aws_cloudfront_client).to receive(:create_distribution).with(
+          lambda_matcher(lambda { |create_distribution_args|
+            create_distribution_args[:distribution_config][:origins][:items][0][:domain_name]
+          }, "test-bucket.#{website_endpoint}")
+        )
+        ConfigureS3Website::CloudFrontClient.send(
+          :create_distribution,
+          {:config_source => config_source_mock({}, region = region) }
+        )
+      end
+    end
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configure-s3-website
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 2.0.0.pre.RC1
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -131,12 +131,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Configure your AWS S3 bucket to function as a web site