configure-s3-website-ng 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 123b9ee34cdac1ba9fd0c83c923c0ffc100ef7a1791bc7af0f8245d808fc8f50
+  data.tar.gz: 19a34cd18c1c96ce5e48866092c5831647417fb251340da58112e937d69e3a10
+SHA512:
+  metadata.gz: 8fec4eeeafef40128d1f4659d86499ec5ab0040611f64754ffff56b36007c9eb794a5a501540e29d3fbd395da4c139918a9d76e7e7983b21fb2144fb48f000ea
+  data.tar.gz: a9fba0235261025ffac457682cb83d4ba71c82fa1839f00c8a46c5dda91cec36fd865e2e8bc6257d73c88735c1c3cc9c5d736c5e2fa20c50083f83eb4259ad8f

data/.gitignore

@@ -0,0 +1,3 @@
+tmp
+pkg
+Gemfile.lock

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Lauri lehmijoki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,280 @@
+# Notice
+
+This project is a fork from Lauri Lehmijoki's [configure-s3-website](https://github.com/laurilehmijoki/configure-s3-website). The upstream project [is not actively maintained](https://github.com/laurilehmijoki/configure-s3-website/issues/26#issuecomment-1586534812).
+
+The gem has been renamed to configure-s3-website-ng to allow uploading to RubyGems without collisions.
+
+The original README follows.
+
+# Configure-s3-website
+
+[![Build Status](https://secure.travis-ci.org/laurilehmijoki/configure-s3-website.png)](http://travis-ci.org/laurilehmijoki/configure-s3-website)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/configure-s3-website.png)](http://badge.fury.io/rb/configure-s3-website)
+
+Configure an AWS S3 bucket to function as a website easily from a command-line interface.
+
+The bucket may or may not exist. If the bucket does not exist,
+`configure-s3-website` will create it.
+
+For deploying websites to S3, consider using [s3_website](https://github.com/laurilehmijoki/s3_website).
+
+## Install
+
+    gem install configure-s3-website
+
+## Usage
+
+Create a file that contains the name of your AWS profile with access to S3 and the name of the bucket:
+
+```yaml
+profile: name-of-your-aws-profile-with-access
+s3_bucket: name-of-your-bucket
+```
+
+**or** create a file that contains the S3 credentials and the name of the bucket:
+
+```yaml
+s3_id: your-aws-access-key
+s3_secret: your-aws-secret-key
+s3_bucket: name-of-your-bucket
+```
+
+**or** you may omit the `profile` and `s3_id` keys to use the system's default credentials.
+This requires [configuring AWS credentials](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-setting-credentials).
+Options include [setting environment variables](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-credentials-environment),
+using a [shared credentials file](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-credentials-shared),
+or running an [EC2 instance with IAM roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingIAM.html#UsingIAMrolesWithAmazonEC2Instances).
+
+Save the file (as *config.yml*, for example). Now you are ready to go. Run the
+following command:
+
+    configure-s3-website --config-file config.yml
+
+Congratulations! You now have an S3 bucket that can act as a website server for
+you.
+
+### Deliver your website via CloudFront
+
+This gem can create new CloudFront distributions and update existing ones.
+
+#### Creating a new distribution
+
+`configure-s3-website` can create a CloudFront distribution for you. It will ask
+you whether you want to deliver your website via the CDN. If you answer yes,
+`configure-s3-website` will create a CloudFront distribution that has the
+configured S3 bucket as its origin. In addition, it will add the entry
+`cloudfront_distribution_id: [id-of-the-new-distribution]` into your
+configuration file.
+
+CloudFront can be configured in various ways. However, the distribution created
+by `configure-s3-website` uses sensible defaults for an S3-based website and
+thus saves you the burden of figuring out how to configure CloudFront. For
+example, it assumes that your default root object is *index.html*.
+
+You can see all the settings this gem applies on the new distribution by running
+the command in verbose mode:
+
+    configure-s3-website --config-file config.yml --verbose
+
+Note that if you already have the key `cloudfront_distribution_id` in your
+configuration file, `configure-s3-website` will not create a new distribution.
+Conversely, if you remove the `cloudfront_distribution_id` key from the file and
+run `configure-s3-website` again, it will create you a new distribution.
+
+##### Creating a new distribution with custom settings
+
+If the default settings do not suit you, you can create a new distribution with
+your settings by adding `cloudfront_distribution_config` values into your config
+file. For example:
+
+```yaml
+cloudfront_distribution_config:
+  default_cache_behavior:
+    min_ttl: 600
+  aliases:
+    quantity: 1
+    items:
+      - your.domain.net
+```
+
+See the section below for more information about the valid values of the
+`cloudfront_distribution_config` setting.
+
+If you want to, you can look at the distribution settings on the management console
+at <https://console.aws.amazon.com/cloudfront>.
+
+#### Updating an existing distribution
+
+You can modify an existing CloudFront distribution by defining the id of the
+distribution and the configs you wish to override the defaults with.
+
+Let's say your config file contains the following fragment:
+
+```yaml
+cloudfront_distribution_id: AXSAXSSE134
+cloudfront_distribution_config:
+  default_cache_behavior:
+    min_ttl: 600
+  default_root_object: index.json
+```
+
+When you invoke `configure-s3-website`, it will overwrite the default value of
+*default_cache_behavior's* *min_ttl* as well as the default value of
+*default_root_object* setting in the [default distribution configs](#default-distribution-configs).
+
+This gem generates `<DistributionConfig>` of the CloudFront REST API. For
+reference, see
+<http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/GetConfig.html#GetConfig_Responses>
+(example) and
+<https://cloudfront.amazonaws.com/doc/2012-07-01/AmazonCloudFrontCommon.xsd>
+(XSD). In other words, When you call `configure-s3-website`, it will turn the values of your
+`cloudfront_distribution_config` into XML, include them in the
+`<DistributionConfig>` element and send them to the CloudFront REST API.
+
+The YAML keys in the config file will be turned into CloudFront REST API XML
+with the same logic as in [configuring redirects](#configuring-redirects).
+
+Having the distribution settings in the config file is handy, because it allows
+you to store most (in many cases all) website deployment settings in one file.
+
+#### Default distribution configs
+
+Below is the default CloudFront distribution config. It is built based on the
+API version 2012-07-01 of [DistributionConfig Complex
+Type](http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html).
+
+```ruby
+{
+  'caller_reference' => 'configure-s3-website gem [generated-timestamp]',
+  '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' => '[generated-string]',
+    'trusted_signers' => {
+      'enabled' => 'false',
+      'quantity' => '0'
+    },
+    'forwarded_values' => {
+      'query_string' => 'true',
+      'cookies' => {
+        'forward' => 'all'
+      }
+    },
+    'viewer_protocol_policy' => 'allow-all',
+    'min_ttl' => '86400'
+  },
+  'cache_behaviors' => {
+    'quantity' => '0'
+  },
+  'price_class' => 'PriceClass_All'
+}
+```
+
+### 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).
+
+
+### Specifying non-standard index or error documents
+
+By default, `configure-s3-website` uses `index.html` for the index document and `error.html` for the error document.
+
+You can override either or both of these defaults like this:
+
+    index_document: default.html
+    error_document: 404.html
+
+You can specify the name of any document in the bucket.
+
+
+### Configuring redirects
+
+You can configure redirects on your S3 website by adding `routing_rules` into
+the config file.
+
+Here is an example:
+
+````yaml
+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
+````
+
+You can use any routing rule property that the [REST
+API](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html)
+supports. All you have to do is to replace the uppercase letter in AWS XML with
+an underscore and an undercase version of the same letter. For example,
+`KeyPrefixEquals` becomes `key_prefix_equals` in the config file.
+
+Apply the rules by invoking `configure-s3-website --config [your-config-file]`
+on the command-line interface. You can verify the results by looking at your
+bucket on the [S3 console](https://console.aws.amazon.com/s3/home).
+
+## How does `configure-s3-website` work?
+
+`configure-s3-website` uses the AWS REST API of S3 for creating and modifying
+the bucket. In brief, it does the following things:
+
+1. Create a bucket for you (if it does not yet exist)
+2. Add the website configuration on the bucket via the [website REST
+   API](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html)
+3. Make the bucket **readable to the whole world**
+4. Apply the redirect (a.k.a routing) rules on the bucket website
+
+When interacting with CloudFront, `configure-s3-website` uses the [POST
+Distribution](http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/CreateDistribution.html),
+[GET
+Distribution](http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/GetDistribution.html) and [PUT Distribution Config](http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/PutConfig.html) APIs.
+
+### Running headlessly
+
+Use the `--headless` option to run without user interaction. If you add the
+`--autocreate-cloudfront-dist` option, `configure-s3-website` will automatically
+create a CloudFront distribution for your S3 website.
+
+## Development
+
+* This project uses [Semantic Versioning](http://semver.org)
+
+## Credit
+
+Created by Lauri Lehmijoki.
+
+Big thanks to the following contributors (in alphabetical order):
+
+* SlawD
+* Steve Schwartz
+* Toby Marsden
+
+## Supported Ruby versions
+
+The file `.travis.yml` defines the officially supported Ruby versions. This gem
+might work on other versions as well, but they are not covered with continuous
+integration.
+
+## License
+
+See the file LICENSE.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Build the project"
+task :default => 'test'
+
+desc "Run tests"
+task :test do
+  sh "bundle exec rspec"
+end
+

data/bin/configure-s3-website

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require 'configure-s3-website'
+
+options, optparse = ConfigureS3Website::CLI.optparse_and_options
+
+optparse.parse!
+
+ConfigureS3Website::Runner.run(options)

data/changelog.md

@@ -0,0 +1,157 @@
+# Changelog
+
+This project uses [Semantic Versioning](http://semver.org).
+
+## 2.3.0
+
+* Add support for default credentials providers
+
+## 2.2.0
+
+* Convert `http_error_code_returned_equals` value to string 
+
+## 2.1.0
+
+* Add ability to use an AWS profile instead of explicit `s3_id` and `s3_secret`
+
+## 2.0.0
+
+### Breaking changes
+
+The CloudFront integration now uses the official Ruby AWS
+SDK. As a consequence, 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 the CloudFront client
+  reports and try again.
+
+Also, the arrays in hashes are now merged:
+
+```
+source = {:x => [{:y => 1}]}
+dest   = {:x => [{:z => 2}]}
+# merge...
+Results: {:x => [{:y => 1, :z => 2}]}
+```
+
+With the help of array merging, given your config file contains the following
+setting:
+
+```yaml
+cloudfront_distribution_config:
+  origins:
+    items:
+      - origin_path: /subfolder
+```
+
+... `configure-s3-website` will include the `origin_path` setting within the
+properties of the first element in the `items` array of your distribution
+settings.
+
+## 1.7.5
+
+* Fix CreateBucket broken in 1.7.4
+
+## 1.7.4
+
+* Support all AWS regions
+
+## 1.7.3
+
+* see <https://github.com/laurilehmijoki/configure-s3-website/pull/13>
+
+## 1.7.2
+
+* See <https://github.com/laurilehmijoki/configure-s3-website/pull/11>
+
+## 1.7.1
+
+* Change CloudFront `OriginProtocolPolicy` to `http-only`
+
+  See <https://github.com/laurilehmijoki/s3_website/issues/152> for discussion.
+
+## 1.7.0
+
+* Add eu-central-1 Region
+
+## 1.6.0
+
+* Add switches `--headless` and `--autocreate-cloudfront-dist`
+
+## 1.5.5
+
+* Fix bug that prevented creating new CloudFront distributions in the EU region
+
+## 1.5.4
+
+* Remove usage of the deprecated OpenSSL::Digest::Digest
+
+## 1.5.3
+
+* Do not override ERB code when adding CloudFront dist
+
+## 1.5.2
+
+* Support location constraint eu-west-1
+
+## 1.5.1
+
+* Use the S3 website domain as the Cloudfront origin
+
+  Replace `S3OriginConfig` with `CustomOriginConfig`. This solves the issue
+  https://github.com/laurilehmijoki/configure-s3-website/issues/6.
+
+## 1.5.0
+
+* Add support for custom index and error documents
+
+## 1.4.0
+
+* Allow the user to store his CloudFront settings in the config file
+ * Support updating configs of an existing CloudFront distribution
+ * Support creating of new distros with custom CloudFront configs
+
+## 1.3.0
+
+* Create a CloudFront distro if the user wants to deliver his S3 website via the
+  CDN
+
+## 1.2.0
+
+* Support configuring redirects on the S3 website
+
+## 1.1.2
+
+* Use UTC time when signing requests
+
+## 1.1.1
+
+* Do not send the location constraint XML when using the standard region
+
+## 1.1.0
+
+* Add support for non-standard AWS regions

data/configure-s3-website.gemspec

@@ -0,0 +1,23 @@
+require File.join([File.dirname(__FILE__),'lib','configure-s3-website','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'configure-s3-website-ng'
+  s.version = ConfigureS3Website::VERSION
+  s.author = ['Ingelabs', 'Lauri Lehmijoki']
+  s.email = 'info@ingelabs.com'
+  s.homepage = 'https://github.com/ingelabs/configure-s3-website'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Fork of configure-s3-website - Configure your AWS S3 bucket to function as a web site'
+  s.bindir = 'bin'
+
+  s.add_dependency 'deep_merge', '~> 1.0.0'
+  s.add_dependency 'aws-sdk', '~> 2'
+
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rspec-expectations', '~> 3'
+  s.add_development_dependency 'rake', '~> 0.9.0'
+
+  s.files         = `git ls-files`.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/cli.rb

@@ -0,0 +1,43 @@
+module ConfigureS3Website
+  class CLI
+    def self.optparse_and_options
+      options = {}
+      optparse = OptionParser.new do |opts|
+        opts.banner = banner
+        opts.on('--headless',
+                'Run without interaction from the user. See the --autocreate-cloudfront-dist for more info.') do
+          options[:headless] = true
+        end
+        opts.on('--autocreate-cloudfront-dist',
+                'When running with --headless, automatically create a CloudFront distribution for your S3 website.') do
+          options['autocreate-cloudfront-dist'] = true
+        end
+        opts.on('-f', '--config-file FILE',
+                'Pick credentials and the S3 bucket name from a config file') do
+                |yaml_file_path|
+          options[:config_source] =
+            ConfigureS3Website::FileConfigSource.new yaml_file_path
+        end
+        opts.on('-v', '--verbose', 'Print more stuff') do
+          options[:verbose] = true
+        end
+        opts.on('--help', 'Display this screen') do
+          puts opts
+          exit
+        end
+      end
+      [options, optparse]
+    end
+
+    private
+
+    def self.banner
+      %|Usage: #{File.basename(__FILE__)} arguments
+
+Configure your S3 bucket to function as a web site
+
+Arguments:
+      |
+    end
+  end
+end