configure-s3-website-ng 3.0.0

data/spec/cloudfront_client_spec.rb

@@ -0,0 +1,138 @@
+require 'rspec'
+require 'configure-s3-website'
+
+describe ConfigureS3Website::CloudFrontClient do
+  RSpec::Matchers.define :lambda_matcher do |lmbda, expected_value|
+    match { |create_distribution_args|
+      lmbda.call(create_distribution_args) == expected_value
+    }
+  end
+
+  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(: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
+      }
+    }
+
+    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(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
+
+    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

data/spec/config_source/file_config_source_spec.rb

@@ -0,0 +1,68 @@
+require 'rspec'
+require 'configure-s3-website'
+require 'tempfile'
+
+describe ConfigureS3Website::FileConfigSource do
+  let(:yaml_file_path) {
+    'spec/sample_files/_config_file_with_eruby.yml'
+  }
+
+  let(:config_source) {
+    ConfigureS3Website::FileConfigSource.new(yaml_file_path)
+  }
+
+  it 'can parse files that contain eRuby code' do
+    expect(config_source.s3_access_key_id).to eq('hello world')
+    expect(config_source.s3_secret_access_key).to eq('secret world')
+    expect(config_source.s3_bucket_name).to eq('my-bucket')
+  end
+
+  it 'returns the yaml file path as description' do
+    expect(config_source.description).to eq(yaml_file_path)
+  end
+
+  it 'does not require s3_id, s3_secret or profile ' do
+    config_no_credentials = ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file_no_credentials.yml')
+    expect(config_no_credentials.s3_access_key_id).to be_nil
+    expect(config_no_credentials.s3_secret_access_key).to be_nil
+    expect(config_no_credentials.profile).to be_nil
+    expect(config_no_credentials.s3_bucket_name).to eq('my-bucket')
+  end
+
+  describe 'setter for cloudfront_distribution_id' do
+    let(:original_yaml_contents) {
+      %Q{
+s3_id: foo
+s3_secret: <%= ENV['my-s3-secret'] %>
+s3_bucket: helloworld.com
+
+# This is a comment
+      }
+    }
+
+    let(:result) {
+      config_file = Tempfile.new 'testfile'
+      config_file.write original_yaml_contents
+      config_file.close
+      config_source = ConfigureS3Website::FileConfigSource.new(config_file.path)
+      config_source.cloudfront_distribution_id = 'xxyyzz'
+      File.open(config_file.path).read
+    }
+
+    it 'retains the ERB code' do
+      expect(result).to include "<%= ENV['my-s3-secret'] %>"
+    end
+
+    it 'appends the CloudFront id as the last enabled value in the YAML file' do
+      expected = %Q{
+s3_id: foo
+s3_secret: <%= ENV['my-s3-secret'] %>
+s3_bucket: helloworld.com
+cloudfront_distribution_id: xxyyzz
+
+# This is a comment
+      }
+      expect(result).to eq(expected)
+    end
+  end
+end

data/spec/s3_client_spec.rb

@@ -0,0 +1,162 @@
+require 'rspec'
+require 'configure-s3-website'
+
+Aws.config[:stub_responses] = true
+
+describe ConfigureS3Website::S3Client do
+  context 'bucket name' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_custom_index_and_error_docs.yml')
+    }
+
+    it 'calls the S3 API with the correct bucket name' do
+      allow_any_instance_of(Aws::S3::Client).to receive(:put_bucket_website).with(
+        hash_including(
+          :bucket => "my-bucket"
+        )
+      )
+      ConfigureS3Website::S3Client.configure_website({config_source: config_source})
+    end
+  end
+
+  describe 'the EU region alias' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file_EU.yml')
+    }
+
+    it 'translates into eu-west-1' do
+        allow_any_instance_of(Aws::S3::Client).to receive(:create_bucket).with(
+          hash_including(
+            create_bucket_configuration: {
+              location_constraint: 'eu-west-1'
+            }
+          )
+        )
+        ConfigureS3Website::S3Client.send(:create_bucket, config_source)
+    end
+  end
+
+  context 'custom index and error documents' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_custom_index_and_error_docs.yml')
+    }
+
+    it 'calls the S3 API with the custom index and error documents' do
+      allow_any_instance_of(Aws::S3::Client).to receive(:put_bucket_website).with(
+        hash_including(
+          :website_configuration=> {
+            :index_document => {
+              :suffix => "default.html"
+            },
+            :error_document => {
+              :key => "404.html"
+            },
+            :routing_rules => nil
+          }
+        )
+      )
+      ConfigureS3Website::S3Client.configure_website({config_source: config_source})
+    end
+  end
+
+  context 'create bucket' do
+    [
+      { :region => 'us-east-1' },
+      { :region => 'us-west-1' },
+      { :region => 'us-west-2' },
+      { :region => 'ap-south-1' },
+      { :region => 'ap-northeast-2' },
+      { :region => 'ap-southeast-1' },
+      { :region => 'ap-southeast-2' },
+      { :region => 'ap-northeast-1' },
+      { :region => 'eu-central-1' },
+      { :region => 'eu-west-1' },
+      { :region => 'sa-east-1' },
+    ].each { |conf|
+      it 'calls the S3 CreateBucket API with the correct location constraint' do
+        allow_any_instance_of(Aws::S3::Client).to receive(:create_bucket).with(
+          hash_including(
+            create_bucket_configuration: 
+              if conf[:region] == 'us-east-1'
+                nil
+              else
+                {
+                  location_constraint: conf[:region]
+                }
+              end
+          )
+        )
+        config_source = double('config_source')
+        allow(config_source).to receive(:s3_access_key_id).and_return('test')
+        allow(config_source).to receive(:s3_secret_access_key).and_return('test')
+        allow(config_source).to receive(:s3_bucket_name).and_return('test-bucket')
+        allow(config_source).to receive(:s3_endpoint).and_return(conf[:region])
+        ConfigureS3Website::S3Client.send(:create_bucket, config_source)
+      end
+    }
+  end
+
+  context 'bucket policy' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_custom_index_and_error_docs.yml')
+    }
+
+    it 'sets the bucket readable to the whole world' do
+      allow_any_instance_of(Aws::S3::Client).to receive(:put_bucket_policy).with(
+        hash_including(
+          :policy => "{\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:::my-bucket/*\"]\n          }]\n        }"
+        )
+      )
+      ConfigureS3Website::S3Client.configure_website({config_source: config_source})
+    end
+  end
+
+  context 'redirect rules' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml')
+    }
+
+    it 'calls the S3 API with the redirect rules settings' do
+      allow_any_instance_of(Aws::S3::Client).to receive(:put_bucket_website).with(
+        hash_including(
+          :website_configuration => {
+            :index_document => {
+              :suffix => "default.html"
+            },
+            :error_document => {
+              :key => "missing.html"
+            },
+            :routing_rules => [
+              {
+                :condition => {
+                  :key_prefix_equals => "blog/some_path"
+                },
+                :redirect => {
+                  :host_name => "blog.example.com",
+                  :replace_key_prefix_with => "some_new_path/",
+                  :http_redirect_code => "301"
+                }
+              }
+            ]
+          }
+        )
+      )
+      ConfigureS3Website::S3Client.configure_website({config_source: config_source})
+    end
+  end
+
+  context 's3_id, s3_secret and profile not required' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file_no_credentials.yml')
+    }
+
+    it 'calls the S3 API successfully' do
+      allow_any_instance_of(Aws::S3::Client).to receive(:put_bucket_website).with(
+        hash_including(
+          :bucket => "my-bucket"
+        )
+      )
+      ConfigureS3Website::S3Client.configure_website({config_source: config_source})
+    end
+  end
+end

data/spec/sample_files/_config_file.yml

@@ -0,0 +1,3 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket

data/spec/sample_files/_config_file_EU.yml

@@ -0,0 +1,4 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket
+s3_endpoint: EU

data/spec/sample_files/_config_file_no_credentials.yml

@@ -0,0 +1 @@
+s3_bucket: my-bucket

data/spec/sample_files/_config_file_oregon.yml

@@ -0,0 +1,4 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket
+s3_endpoint: us-west-2

data/spec/sample_files/_config_file_with_eruby.yml

@@ -0,0 +1,3 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket

data/spec/sample_files/_custom_index_and_error_docs.yml

@@ -0,0 +1,5 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket
+index_document: default.html
+error_document: 404.html

data/spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml

@@ -0,0 +1,12 @@
+s3_id: <%= 'hello world' %>
+s3_secret: <%= 'secret world' %>
+s3_bucket: my-bucket
+index_document: default.html
+error_document: missing.html
+routing_rules:
+  - condition:
+      key_prefix_equals: blog/some_path
+    redirect:
+      host_name: blog.example.com
+      replace_key_prefix_with: some_new_path/
+      http_redirect_code: 301

data/spec/xml_helper_spec.rb

@@ -0,0 +1,39 @@
+require 'rspec'
+require 'configure-s3-website'
+
+describe ConfigureS3Website::XmlHelper do
+  context '#hash_to_api_xml' do
+    it 'returns an empty string, if the hash is empty' do
+      str = ConfigureS3Website::XmlHelper.send(:hash_to_api_xml,
+                                        { })
+      expect(str).to eq('')
+    end
+
+    it 'capitalises hash keys but not values' do
+      str = ConfigureS3Website::XmlHelper.send(:hash_to_api_xml,
+                                        { 'key' => 'value' })
+      expect(str).to eq("\n<Key>value</Key>")
+    end
+
+    it 'removes underscores and capitalises the following letter' do
+      str = ConfigureS3Website::XmlHelper.send(:hash_to_api_xml,
+                                        { 'hello_key' => 'value' })
+      expect(str).to eq("\n<HelloKey>value</HelloKey>")
+    end
+
+    it 'can handle hash values as well' do
+      str = ConfigureS3Website::XmlHelper.send(:hash_to_api_xml,
+                                        { 'key' => { 'subkey' => 'subvalue' } })
+      expect(str).to eq("\n<Key>\n  <Subkey>subvalue</Subkey></Key>")
+    end
+
+    it 'indents' do
+      str = ConfigureS3Website::XmlHelper.send(
+        :hash_to_api_xml,
+        { 'key' => { 'subkey' => 'subvalue' } },
+        indent = 1
+      )
+      expect(str).to eq("\n  <Key>\n    <Subkey>subvalue</Subkey></Key>")
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: configure-s3-website-ng
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Ingelabs
+- Lauri Lehmijoki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email: info@ingelabs.com
+executables:
+- configure-s3-website
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/configure-s3-website
+- changelog.md
+- configure-s3-website.gemspec
+- lib/configure-s3-website.rb
+- lib/configure-s3-website/cli.rb
+- lib/configure-s3-website/cloudfront_client.rb
+- lib/configure-s3-website/config_source/config_source.rb
+- lib/configure-s3-website/config_source/file_config_source.rb
+- lib/configure-s3-website/endpoint_helper.rb
+- lib/configure-s3-website/http_helper.rb
+- lib/configure-s3-website/runner.rb
+- lib/configure-s3-website/s3_client.rb
+- lib/configure-s3-website/version.rb
+- lib/configure-s3-website/xml_helper.rb
+- spec/cloudfront_client_spec.rb
+- spec/config_source/file_config_source_spec.rb
+- spec/s3_client_spec.rb
+- spec/sample_files/_config_file.yml
+- spec/sample_files/_config_file_EU.yml
+- spec/sample_files/_config_file_no_credentials.yml
+- spec/sample_files/_config_file_oregon.yml
+- spec/sample_files/_config_file_with_eruby.yml
+- spec/sample_files/_custom_index_and_error_docs.yml
+- spec/sample_files/_custom_index_and_error_docs_with_routing_rules.yml
+- spec/xml_helper_spec.rb
+homepage: https://github.com/ingelabs/configure-s3-website
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Fork of configure-s3-website - Configure your AWS S3 bucket to function as
+  a web site
+test_files: []