jekyll-s3 2.0.0 → 2.1.0

data/README.md

@@ -18,30 +18,28 @@ Deploy your jekyll site to S3.
 
 ## Setup
 
-  * Go to your jekyll site directory
-  * Run `jekyll-s3`. It generates a configuration file called `_jekyll_s3.yml` that looks like that:
+* Go to your jekyll site directory
+* Run `jekyll-s3`. It generates a configuration file called `_jekyll_s3.yml` that looks like this:
 <pre>
 s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
 s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
 s3_bucket: your.blog.bucket.com
-cloudfront_distribution_id: YOUR_CLOUDFRONT_DIST_ID (OPTIONAL)
 </pre>
 
-  * Edit it with your details.
-  * Hint: you can use ERB syntax in `_jekyll_s3.yml`. This is handy, if you
-    want to store the AWS credentials as environmental variables.
+* Edit it with your details (you can use [ERB](http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html) in the file)
+* [Configure your S3 bucket to function like a website](http://docs.amazonwebservices.com/AmazonS3/latest/dev/HostingWebsiteOnS3Setup.html)
 
 ## Deploy!
 
   * Run `jekyll-s3`. Done.
 
-## Want the root url to render index.html?
+## Reduced Redundancy
 
-  * Log into <https://console.aws.amazon.com/s3/home>
-  * Set the Index document to index.html in Bucket Properties >
-    Website.
-  * Visit the website endpoint:
-    (http://yourblog.s3-website...amazonaws.com)
+You can reduce the cost of hosting your blog on S3 by using Reduced Redundancy Storage:
+
+  * In `_jekyll_s3.yml`, set `s3_reduced_redundancy: true`
+  * All objects uploaded after this change will use the Reduced Redundancy Storage.
+  * If you want to change all of the files in the bucket, you can change them through the AWS console, or update the timestamp on the files before running `jekyll-s3` again
 
 ## How to use Cloudfront to deliver your blog
 
@@ -68,6 +66,10 @@ Enable the headless mode by adding the `--headless` or `-h` argument after
 
 ## Changelog
 
+### 2.1.0
+
+* Added support for S3 reduced redundancy storage
+
 ### 2.0.0
 
 * Set content type of the uploaded files
@@ -120,3 +122,4 @@ Contributors (in alphabetical order)
 * Chris Kelly
 * Chris Moos
 * Lauri Lehmijoki
+* Mason Turner

data/features/cli-output.feature

@@ -21,6 +21,7 @@ Feature: Command-line interface feedback
       s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
       s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
       s3_bucket: your.blog.bucket.com
+      s3_reduced_redundancy: false
       cloudfront_distribution_id: YOUR_CLOUDFRONT_DIST_ID (OPTIONAL)
       """
 
@@ -34,6 +35,7 @@ Feature: Command-line interface feedback
       s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
       s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
       s3_bucket: your.blog.bucket.com
+      s3_reduced_redundancy: false
       """
 
   Scenario: Run jekyll-s3 with a malformed configuration file
@@ -50,6 +52,7 @@ Feature: Command-line interface feedback
       s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
       s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
       s3_bucket: your.blog.bucket.com
+      s3_reduced_redundancy: false
       """
 
   Scenario: Run jekyll-s3 with a configuration file that does not contain a bucket
@@ -59,6 +62,7 @@ Feature: Command-line interface feedback
       s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
       s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
       s3_bucket:
+      s3_reduced_redundancy: false
       """
     When I run `jekyll-s3`
     Then the output should contain:
@@ -67,6 +71,7 @@ Feature: Command-line interface feedback
       s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
       s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
       s3_bucket: your.blog.bucket.com
+      s3_reduced_redundancy: false
       """
 
   Scenario: Run jekyll-s3

data/features/support/env.rb

@@ -10,6 +10,7 @@ require 'cucumber/rspec/doubles'
 Before do
   @__aruba_original_paths = (ENV['PATH'] || '').split(File::PATH_SEPARATOR)
   ENV['PATH'] = ([File.expand_path('bin')] + @__aruba_original_paths).join(File::PATH_SEPARATOR)
+  @aruba_timeout_seconds = 5
 end
 
 After do

data/jekyll-s3.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "jekyll-s3"
-  s.version     = "2.0.0"
+  s.version     = "2.1.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
   s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]
@@ -15,7 +15,7 @@ distribution, making it easy to deliver your blog via the CDN.}
 
   s.default_executable = %q{jekyll-s3}
 
-  s.add_dependency 'aws-sdk', '~> 1.5.6'
+  s.add_dependency 'aws-sdk', '~> 1.8.0'
   s.add_dependency 'filey-diff', '~> 0.0.2'
   s.add_dependency 'simple-cloudfront-invalidator', '~> 1.0.0'
   s.add_dependency 'erubis', '~> 2.7.0'

data/lib/jekyll-s3/config_loader.rb

@@ -6,6 +6,7 @@ module Jekyll
 s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
 s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
 s3_bucket: your.blog.bucket.com
+s3_reduced_redundancy: false
 cloudfront_distribution_id: YOUR_CLOUDFRONT_DIST_ID (OPTIONAL)
       EOF
 

data/lib/jekyll-s3/uploader.rb

@@ -2,22 +2,21 @@ module Jekyll
   module S3
     class Uploader
       def self.run(site_dir, config, in_headless_mode = false)
-        s3_id = config['s3_id']
-        s3_secret = config['s3_secret']
-        s3_bucket_name = config['s3_bucket']
-        puts "Deploying _site/* to #{s3_bucket_name}"
+        puts "Deploying _site/* to #{config['s3_bucket']}"
 
-        s3 = AWS::S3.new(:access_key_id => s3_id,
-                         :secret_access_key => s3_secret)
+        s3 = AWS::S3.new(:access_key_id => config['s3_id'],
+                         :secret_access_key => config['s3_secret'])
 
-        create_bucket_if_needed(s3, s3_bucket_name)
+        create_bucket_if_needed(s3, config['s3_bucket'])
 
-        new_files_count, changed_files_count, changed_files = upload_files(s3, s3_bucket_name, site_dir)
+        new_files_count, changed_files_count, changed_files = upload_files(
+          s3, config, site_dir
+        )
 
         deleted_files_count = remove_superfluous_files(
-          s3, s3_bucket_name, site_dir, in_headless_mode)
+          s3, config['s3_bucket'], site_dir, in_headless_mode)
 
-        puts "Done! Go visit: http://#{s3_bucket_name}.s3.amazonaws.com/index.html"
+        puts "Done! Go visit: http://#{config['s3_bucket']}.s3.amazonaws.com/index.html"
         [new_files_count, changed_files_count, deleted_files_count, changed_files]
       end
 
@@ -30,9 +29,9 @@ module Jekyll
         end
       end
 
-      def self.upload_files(s3, s3_bucket_name, site_dir)
+      def self.upload_files(s3, config, site_dir)
         changed_files, new_files = DiffHelper.resolve_files_to_upload(
-          s3.buckets[s3_bucket_name], site_dir)
+          s3.buckets[config['s3_bucket']], site_dir)
         to_upload = changed_files + new_files
         if to_upload.empty?
           puts "No new or changed files to upload"
@@ -45,18 +44,19 @@ module Jekyll
           pre_upload_report << "file(s)"
           puts pre_upload_report.join(' ')
           to_upload.each do |f|
-            upload_file(f, s3, s3_bucket_name, site_dir)
+            upload_file(f, s3, config, site_dir)
           end
         end
         [new_files.length, changed_files.length, changed_files]
       end
 
-      def self.upload_file(file, s3, s3_bucket_name, site_dir)
+      def self.upload_file(file, s3, config, site_dir)
         Retry.run_with_retry do
           mime_type = MIME::Types.type_for(file)
-          upload_succeeded = s3.buckets[s3_bucket_name].objects[file].write(
+          upload_succeeded = s3.buckets[config['s3_bucket']].objects[file].write(
             File.read("#{site_dir}/#{file}"),
-            :content_type => mime_type.first
+            :content_type => mime_type.first ,
+            :reduced_redundancy => config['s3_reduced_redundancy'],
           )
           if upload_succeeded
             puts("Upload #{file}: Success!")

data/spec/lib/upload_spec.rb

@@ -1,51 +1,86 @@
 require 'spec_helper'
 
 describe Jekyll::S3::Uploader do
+  describe 'reduced redundancy setting' do
+    let(:config) {
+      { 's3_reduced_redundancy' => true }
+    }
+
+    it 'allows storing a file under the Reduced Redundancy Storage' do
+      file_to_upload = 'index.html'
+      s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+        s3_object.should_receive(:write).with(
+          anything(),
+          :content_type => 'text/html',
+          :reduced_redundancy => true
+        )
+      end
+      Jekyll::S3::Uploader.send(:upload_file,
+                                file_to_upload,
+                                s3_client,
+                                config,
+                                'features/support/test_site_dirs/my.blog.com/_site')
+    end
+  end
+
   describe 'content type resolving' do
+    let(:config) {
+      { 's3_reduced_redundancy' => false }
+    }
+
     it 'adds the content type of the uploaded CSS file into the S3 object' do
       file_to_upload = 'css/styles.css'
+      s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+        s3_object.should_receive(:write).with(
+          anything(),
+          :content_type => 'text/css',
+          :reduced_redundancy => false
+        )
+      end
       Jekyll::S3::Uploader.send(:upload_file,
                                 file_to_upload,
-                                create_content_type_verifying_s3(file_to_upload),
-                                'some_bucket_name',
+                                s3_client,
+                                config,
                                 'features/support/test_site_dirs/my.blog.com/_site')
     end
 
     it 'adds the content type of the uploaded HTML file into the S3 object' do
       file_to_upload = 'index.html'
+      s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+        s3_object.should_receive(:write).with(
+          anything(),
+          :content_type => 'text/html',
+          :reduced_redundancy => false
+        )
+      end
       Jekyll::S3::Uploader.send(:upload_file,
                                 file_to_upload,
-                                create_content_type_verifying_s3(file_to_upload),
-                                'some_bucket_name',
+                                s3_client,
+                                config,
                                 'features/support/test_site_dirs/my.blog.com/_site')
     end
+  end
 
-    def create_content_type_verifying_s3(file_to_upload)
-      def create_objects(file_to_upload)
-        def create_html_s3_object(file_to_upload)
-          s3_object = stub('s3_object')
-          content_type = (file_to_upload.end_with?'html') ? 'text/html' : 'text/css'
-          s3_object.should_receive(:write).with(
-            anything(),
-            # Ensure that the write method is called with the correct content type:
-            :content_type => content_type
-          )
-          s3_object
-        end
-        objects = {}
-        objects[file_to_upload] = create_html_s3_object(file_to_upload)
-        objects
-      end
-      def create_bucket(file_to_upload)
-        bucket = stub('bucket')
-        bucket.stub(:objects => create_objects(file_to_upload))
-        bucket
+  def create_verifying_s3_client(file_to_upload, &block)
+    def create_objects(file_to_upload, &block)
+      def create_html_s3_object(file_to_upload, &block)
+        s3_object = stub('s3_object')
+        yield s3_object
+        s3_object
       end
-      buckets = stub('buckets')
-      buckets.stub(:[] => create_bucket(file_to_upload))
-      s3 = stub('s3')
-      s3.stub(:buckets => buckets)
-      s3
+      objects = {}
+      objects[file_to_upload] = create_html_s3_object(file_to_upload, &block)
+      objects
+    end
+    def create_bucket(file_to_upload, &block)
+      bucket = stub('bucket')
+      bucket.stub(:objects => create_objects(file_to_upload, &block))
+      bucket
     end
+    buckets = stub('buckets')
+    buckets.stub(:[] => create_bucket(file_to_upload, &block))
+    s3 = stub('s3')
+    s3.stub(:buckets => buckets)
+    s3
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-s3
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: filey-diff
   requirement: !ruby/object:Gem::Requirement