configure-s3-website 1.2.0 → 1.3.0

data/features/step_definitions/steps.rb

@@ -1,16 +1,18 @@
 require 'rspec'
 
-Given /^my config file is in "(.*?)"$/ do |config_file_path|
-  @config_file_path = config_file_path
-end
-
-When /^I run the configure-s3-website command$/ do
+When /^I run the configure-s3-website command with parameters$/ do |table|
+  options, optparse = ConfigureS3Website::CLI.optparse_and_options
+  optparse.parse! args_array_from_cucumber_table(table)
+  @reset = create_reset_config_file_function options[:config_source].description
   @console_output = capture_stdout {
-    config_source = ConfigureS3Website::FileConfigSource.new(@config_file_path)
-    ConfigureS3Website::S3Client.configure_website(config_source)
+    ConfigureS3Website::Runner.run(options, stub_stdin)
   }
 end
 
+Given /^I answer 'yes' to 'do you want to use CloudFront'$/ do
+  @first_stdin_answer = 'y'
+end
+
 Then /^the output should be$/ do |expected_console_output|
   @console_output.should eq(expected_console_output)
 end
@@ -19,6 +21,41 @@ Then /^the output should include$/ do |expected_console_output|
   @console_output.should include(expected_console_output)
 end
 
+def args_array_from_cucumber_table(table)
+  args = []
+  table.hashes.map do |entry|
+    { entry[:option] => entry[:value] }
+  end.each do |opt|
+    args << opt.keys.first
+    args << opt.values.first if opt.values.first
+  end
+  args
+end
+
+def stub_stdin
+  stdin = stub('std_in')
+  stdin.stub(:gets).and_return {
+    first_stdin_answer
+  }
+  stdin
+end
+
+# A function for bringing back the original config file
+# (in case we modified it during the test)
+def create_reset_config_file_function(yaml_file_path)
+  original_contents = File.open(yaml_file_path, 'r').read
+  -> {
+    File.open(yaml_file_path, 'w') { |yaml_file|
+      yaml_file.puts(original_contents)
+    }
+  }
+end
+
+# The first prompt asks "do you want to create a CloudFront distro"
+def first_stdin_answer
+  @first_stdin_answer || 'n'
+end
+
 module Kernel
   require 'stringio'
 

data/features/support/env.rb

@@ -16,3 +16,7 @@ After do
   ENV['PATH'] = @__aruba_original_paths.join(File::PATH_SEPARATOR)
 end
 # End of following from 'aruba/cucumber'
+
+After do
+  @reset.call if @reset
+end

data/features/support/sample_config_files/config_with_cloudfront_distribution_id.yml

@@ -0,0 +1,4 @@
+s3_id: foo
+s3_secret: foo
+s3_bucket: name-of-an-existing-bucket
+cloudfront_distribution_id: EEFF123

data/features/support/sample_config_files/create_cf_dist.yml

@@ -0,0 +1,3 @@
+s3_id: foo
+s3_secret: foo
+s3_bucket: website-via-cf

data/features/support/vcr.rb

@@ -10,4 +10,5 @@ VCR.cucumber_tags do |t|
   t.tag '@bucket-does-not-exist-in-tokyo'
   t.tag '@bucket-exists'
   t.tag '@redirects'
+  t.tag '@create-cf-dist'
 end

data/lib/configure-s3-website.rb

@@ -1,4 +1,9 @@
 require 'configure-s3-website/version'
 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/runner'
+require 'configure-s3-website/cli'
 require 'configure-s3-website/config_source/config_source'
 require 'configure-s3-website/config_source/file_config_source'

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

@@ -0,0 +1,35 @@
+module ConfigureS3Website
+  class CLI
+    def self.optparse_and_options
+      options = {}
+      optparse = OptionParser.new do |opts|
+        opts.banner = banner
+        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

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

@@ -0,0 +1,117 @@
+require "rexml/document"
+require "rexml/xpath"
+
+module ConfigureS3Website
+  class CloudFrontClient
+    def self.create_distribution_if_user_agrees(options, standard_input)
+      puts 'Do you want to deliver your website via CloudFront, the CDN of Amazon? [y/N]'
+      case standard_input.gets.chomp
+      when /(y|Y)/ then do_create_distribution options
+      end
+    end
+
+    private
+
+    def self.do_create_distribution(options)
+      config_source = options[:config_source]
+      response = HttpHelper.call_cloudfront_api(
+        path = '/2012-07-01/distribution',
+        method = Net::HTTP::Post,
+        body = (distribution_config_xml config_source),
+        config_source = config_source
+      )
+      response_xml = REXML::Document.new(response.body)
+      dist_id = REXML::XPath.first(response_xml, '/Distribution/Id').get_text
+      print_report_on_new_dist response_xml, dist_id, options
+      config_source.cloudfront_distribution_id = dist_id.to_s
+      puts "  Added setting 'cloudfront_distribution_id: #{dist_id}' into #{config_source.description}"
+    end
+
+    def self.print_report_on_new_dist(response_xml, dist_id, options)
+      config_source = options[:config_source]
+      domain_name = REXML::XPath.first(response_xml, '/Distribution/DomainName').get_text
+      puts "  The distribution #{dist_id} at #{domain_name} now delivers the bucket #{config_source.s3_bucket_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_xml, left_padding = 4)
+      end
+    end
+
+    def self.print_verbose(response_xml, left_padding)
+      lines = []
+      response_xml.write(lines, 2)
+      padding = ""
+      left_padding.times { padding << " " }
+      puts lines.join().
+        gsub(/^/, "" + padding).
+        gsub(/\s$/, "")
+    end
+
+    def self.distribution_config_xml(config_source, custom_cf_settings = {})
+      %|
+      <DistributionConfig xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
+        <Origins>
+          <Quantity>1</Quantity>
+          <Items>
+            <Origin>
+              <Id>#{origin_id config_source}</Id>
+              <DomainName>#{config_source.s3_bucket_name}.#{Endpoint.by_config_source(config_source).hostname}</DomainName>
+              <S3OriginConfig>
+                <OriginAccessIdentity></OriginAccessIdentity>
+              </S3OriginConfig>
+            </Origin>
+          </Items>
+        </Origins>
+        #{
+          XmlHelper.hash_to_api_xml(
+            default_cloudfront_settings(config_source).merge custom_cf_settings
+          )
+        }
+      </DistributionConfig>
+      |
+    end
+
+    def self.default_cloudfront_settings(config_source)
+      {
+        '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' => {
+            'enabled' => 'false',
+            'quantity' => '0'
+          },
+          'forwarded_values' => {
+            'query_string' => 'true',
+            'cookies' => {
+              'forward' => 'all'
+            }
+          },
+          'viewer_protocol_policy' => 'allow-all',
+          'min_TTL' => (60 * 60 * 24)
+        },
+        'cache_behaviors' => {
+          'quantity' => '0'
+        },
+        'price_class' => 'PriceClass_All'
+      }
+    end
+
+    def self.origin_id(config_source)
+      "#{config_source.s3_bucket_name}-S3-origin"
+    end
+  end
+end

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

@@ -1,5 +1,8 @@
 module ConfigureS3Website
   class ConfigSource
+    def description
+    end
+
     def s3_access_key_id
     end
 
@@ -14,5 +17,11 @@ module ConfigureS3Website
 
     def routing_rules
     end
+
+    def cloudfront_distribution_id
+    end
+
+    def cloudfront_distribution_id=(dist_id)
+    end
   end
 end

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

@@ -4,7 +4,12 @@ require 'erb'
 module ConfigureS3Website
   class FileConfigSource < ConfigSource
     def initialize(yaml_file_path)
-      @config = parse_config yaml_file_path
+      @yaml_file_path = yaml_file_path
+      @config = FileConfigSource.parse_config yaml_file_path
+    end
+
+    def description
+      @yaml_file_path
     end
 
     def s3_access_key_id
@@ -27,15 +32,26 @@ module ConfigureS3Website
       @config['routing_rules']
     end
 
+    def cloudfront_distribution_id
+      @config['cloudfront_distribution_id']
+    end
+
+    def cloudfront_distribution_id=(dist_id)
+      @config['cloudfront_distribution_id'] = dist_id
+      File.open(@yaml_file_path, 'w') do |yaml_file|
+        yaml_file.puts @config.to_yaml
+      end
+    end
+
     private
 
-    def parse_config(yaml_file_path)
+    def self.parse_config(yaml_file_path)
       config = YAML.load(ERB.new(File.read(yaml_file_path)).result)
       validate_config(config, yaml_file_path)
       config
     end
 
-    def validate_config(config, yaml_file_path)
+    def self.validate_config(config, yaml_file_path)
       required_keys = %w{s3_id s3_secret s3_bucket}
       missing_keys = required_keys.reject do |key| config.keys.include?key end
       unless missing_keys.empty?

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

@@ -0,0 +1,83 @@
+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)
+      date = Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S %Z")
+      digest = create_cloudfront_digest(config_source, date)
+      self.call_api(
+        path, method, body, config_source, 'cloudfront.amazonaws.com', digest, date
+      )
+    end
+
+    private
+
+    def self.call_api(path, method, body, config_source, hostname, digest, date)
+      url = "https://#{hostname}#{path}"
+      uri = URI.parse(url)
+      req = method.new(uri.to_s)
+      req.initialize_http_header({
+        'Date' => date,
+        'Content-Type' => '',
+        'Content-Length' => body.length.to_s,
+        'Authorization' => "AWS %s:%s" % [config_source.s3_access_key_id, digest]
+      })
+      req.body = body
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      res = http.request(req)
+      if res.code.to_i.between? 200, 299
+        res
+      else
+        raise ConfigureS3Website::ErrorParser.create_error res.body
+      end
+    end
+
+    def self.create_s3_digest(path, method, config_source, date)
+      digest = OpenSSL::Digest::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(
+          OpenSSL::Digest::Digest.new('sha1'),
+          config_source.s3_secret_access_key,
+          date
+        )
+      ).strip
+    end
+  end
+end
+
+private
+
+module ConfigureS3Website
+  class ErrorParser
+    def self.create_error(amazon_error_xml)
+      error_code = amazon_error_xml.delete('\n').match(/<Code>(.*?)<\/Code>/)[1]
+      begin
+        Object.const_get("#{error_code}Error").new
+      rescue NameError
+        GenericError.new(amazon_error_xml)
+      end
+    end
+  end
+end
+
+class GenericError < StandardError
+  def initialize(error_message)
+    super("AWS API call failed:\n#{error_message}")
+  end
+end

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

@@ -0,0 +1,17 @@
+module ConfigureS3Website
+  class Runner
+    def self.run(options, standard_input = STDIN)
+      S3Client.configure_website options
+      unless user_already_has_cf_configured options
+        CloudFrontClient.create_distribution_if_user_agrees options, standard_input
+      end
+    end
+
+    private
+
+    def self.user_already_has_cf_configured(options)
+      config_source = options[:config_source]
+      config_source.cloudfront_distribution_id
+    end
+  end
+end

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

@@ -6,7 +6,8 @@ require 'net/https'
 
 module ConfigureS3Website
   class S3Client
-    def self.configure_website(config_source)
+    def self.configure_website(options)
+      config_source = options[:config_source]
       begin
         enable_website_configuration(config_source)
         make_bucket_readable_to_everyone(config_source)
@@ -30,7 +31,7 @@ module ConfigureS3Website
           </ErrorDocument>
         </WebsiteConfiguration>
       |
-      call_s3_api(
+      HttpHelper.call_s3_api(
         path = "/#{config_source.s3_bucket_name}/?website",
         method = Net::HTTP::Put,
         body = body,
@@ -50,7 +51,7 @@ module ConfigureS3Website
           "Resource":["arn:aws:s3:::#{config_source.s3_bucket_name}/*"]
         }]
       }|
-      call_s3_api(
+      HttpHelper.call_s3_api(
         path = "/#{config_source.s3_bucket_name}/?policy",
         method = Net::HTTP::Put,
         body = policy_json,
@@ -76,7 +77,7 @@ module ConfigureS3Website
           body << %|
               <RoutingRule>
           |
-          body << self.hash_to_api_xml(routing_rule, 7)
+          body << XmlHelper.hash_to_api_xml(routing_rule, 7)
           body << %|
               </RoutingRule>
           |
@@ -86,7 +87,7 @@ module ConfigureS3Website
           </WebsiteConfiguration>
         |
 
-        call_s3_api(
+        HttpHelper.call_s3_api(
           path = "/#{config_source.s3_bucket_name}/?website",
           method = Net::HTTP::Put,
           body = body,
@@ -110,7 +111,7 @@ module ConfigureS3Website
          |
              end
 
-      call_s3_api(
+      HttpHelper.call_s3_api(
         path = "/#{config_source.s3_bucket_name}",
         method = Net::HTTP::Put,
         body = body,
@@ -122,51 +123,6 @@ module ConfigureS3Website
           endpoint.region
         ]
     end
-
-    def self.call_s3_api(path, method, body, config_source)
-      endpoint = Endpoint.new(config_source.s3_endpoint || '')
-      date = Time.now.utc.strftime("%a, %d %b %Y %H:%M:%S %Z")
-      digest = create_digest(path, method, config_source, date)
-      url = "https://#{endpoint.hostname}#{path}"
-      uri = URI.parse(url)
-      req = method.new(uri.to_s)
-      req.initialize_http_header({
-        'Date' => date,
-        'Content-Type' => '',
-        'Content-Length' => body.length.to_s,
-        'Authorization' => "AWS %s:%s" % [config_source.s3_access_key_id, digest]
-      })
-      req.body = body
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      res = http.request(req)
-      if res.code.to_i.between? 200, 299
-        res
-      else
-        raise ConfigureS3Website::ErrorParser.create_error res.body
-      end
-    end
-
-    def self.create_digest(path, method, config_source, date)
-      digest = OpenSSL::Digest::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.hash_to_api_xml(hash={}, indent=0)
-      "".tap do |body|
-        hash.each do |key, value|
-          key_name = key.sub(/^[a-z\d]*/) { $&.capitalize }.gsub(/(?:_|(\/))([a-z\d]*)/) { $2.capitalize }
-          value = value.is_a?(Hash) ? self.hash_to_api_xml(value, indent+1) : value
-          body << "\n"
-          body << " " * indent * 2 # 2-space indentation formatting for xml
-          body << "<#{key_name}>#{value}</#{key_name}>"
-        end
-      end
-    end
   end
 end
 
@@ -197,18 +153,9 @@ module ConfigureS3Website
         '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)
-      error_code = amazon_error_xml.delete('\n').match(/<Code>(.*?)<\/Code>/)[1]
-      begin
-        Object.const_get("#{error_code}Error").new
-      rescue NameError
-        GenericS3Error.new(amazon_error_xml)
-      end
+    def self.by_config_source(config_source)
+      endpoint = Endpoint.new(config_source.s3_endpoint || '')
     end
   end
 end
@@ -218,9 +165,3 @@ end
 
 class NoSuchBucketError < StandardError
 end
-
-class GenericS3Error < StandardError
-  def initialize(error_message)
-    super("AWS API call failed:\n#{error_message}")
-  end
-end