jekyll-s3 0.0.4 → 0.0.5

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 1.8.7
+- 1.9.2
+- 1.9.3

data/README.md

@@ -1,5 +1,10 @@
 # jekyll-s3
 
+[![Build
+Status](https://secure.travis-ci.org/laurilehmijoki/jekyll-s3.png)]
+(http://travis-ci.org/laurilehmijoki/jekyll-s3)
+
+
 Deploy your jekyll site to S3.
 
 ## Install
@@ -14,6 +19,7 @@ Deploy your jekyll site to S3.
 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.
@@ -30,12 +36,23 @@ s3_bucket: your.blog.bucket.com
   * Visit the website endpoint:
     (http://yourblog.s3-website...amazonaws.com)
 
+## How to use Cloudfront to deliver your blog
+
+It is easy to deliver your S3-based web site via Cloudfront, the CDN of Amazon.
+
+  * Go to <https://console.aws.amazon.com/cloudfront/home>
+  * Create a distribution and set the your Jekyll S3 bucket as the origin
+  * Add the `cloudfront_distribution_id: your-dist-id` setting into
+    `_jekyll_s3.yml`
+  * Run `jekyll-s3` to deploy your site to S3 and invalidate the Cloudfront
+    distribution
+
 ## Todo
 
   * Upload new / updated files *only* (using s3-sync?)
-  
+
 ## Development
- 
+
   * Install bundler and run `bundle install`
   * Run the integration tests by running `bundle exec cucumber`
   * Run the unit tests by running `bundle exec rspec spec/lib/*.rb`
@@ -47,4 +64,4 @@ MIT
 ## Copyright
 
 Copyright (c) 2011 VersaPay, Philippe Creux.
-  
+

data/Rakefile

@@ -1,2 +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"
+    sh "bundle exec cucumber"
+end

data/features/jekyll-s3-cloudfront.feature

@@ -0,0 +1,22 @@
+Feature: Invalidate the Cloudfront distribution
+
+  In order to publish my posts
+  As a blogger who delivers his blog via an S3-based Cloudfront distribution
+  I want to run jekyll-s3
+  And see, that the items in the distribution were invalidated
+  So that my latest updates will be immediately available to readers
+
+  Scenario: Run jekyll-s3 for the first time
+    Given a directory named "_site"
+    When I run `jekyll-s3`
+    Then the output should contain:
+      """
+      I've just generated a file called _jekyll_s3.yml. Go put your details in it!
+      """
+    Then the file "_jekyll_s3.yml" should contain:
+      """
+      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)
+      """

data/jekyll-s3.gemspec

@@ -6,20 +6,24 @@ Gem::Specification.new do |s|
   s.name        = "jekyll-s3"
   s.version     = Jekyll::S3::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Philippe Creux"]
-  s.email       = ["pcreux@gmail.com"]
-  s.homepage    = "https://github.com/versapay/jekyll-s3"
-  s.summary     = %q{Push your jekyll blog to S3"}
-  s.description = %q{Push your jekyll blog to AWS S3}
+  s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
+  s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]
+  s.homepage    = "https://github.com/laurilehmijoki/jekyll-s3"
+  s.summary     = %q{Push your Jekyll blog to S3}
+  s.description = %q{This Gem allows you to push your Jekyll blog to AWS S3.
+In addition, you can use this Gem to invalidate the related Cloudfront
+distribution, making it easy to deliver your blog via the CDN.}
 
   s.default_executable = %q{jekyll-s3}
 
   s.add_dependency 'aws-s3'
+  s.add_dependency 'simple-cloudfront-invalidator'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'aruba', '>= 0.4.7'
+  s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/cloudfront/invalidator.rb

@@ -0,0 +1,15 @@
+module Jekyll
+  module Cloudfront
+    class Invalidator
+      def self.invalidate(
+        aws_key, aws_secret, s3_bucket_name, cloudfront_distribution_id)
+        bucket = AWS::S3::Bucket.find(s3_bucket_name)
+        s3_object_keys = bucket.objects.map { |f| f.key }
+        report = SimpleCloudfrontInvalidator::CloudfrontClient.new(
+          aws_key, aws_secret, cloudfront_distribution_id).invalidate(
+            s3_object_keys)
+        puts report
+      end
+    end
+  end
+end

data/lib/jekyll-s3.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'yaml'
 require 'aws/s3'
+require 'simple-cloudfront-invalidator'
 
 module Jekyll
   module S3
@@ -10,3 +11,7 @@ end
 %w{errors uploader cli}.each do |file|
   require File.dirname(__FILE__) + "/jekyll-s3/#{file}"
 end
+
+%w{invalidator}.each do |file|
+  require File.dirname(__FILE__) + "/cloudfront/#{file}"
+end

data/lib/jekyll-s3/uploader.rb

@@ -8,8 +8,8 @@ module Jekyll
 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)
       EOF
-        
 
       def self.run!
         new.run!
@@ -18,11 +18,20 @@ s3_bucket: your.blog.bucket.com
       def run!
         check_jekyll_project!
         check_s3_configuration!
+        load_configuration
         upload_to_s3!
+        invalidate_cf_dist_if_configured!
       end
 
       protected
-      
+
+      def invalidate_cf_dist_if_configured!
+        cloudfront_configured = @cloudfront_distribution_id != nil && @cloudfront_distribution_id != ''
+        Jekyll::Cloudfront::Invalidator.invalidate(
+          @s3_id, @s3_secret, @s3_bucket, @cloudfront_distribution_id
+          ) if cloudfront_configured
+      end
+
       def run_with_retry
         begin
           yield
@@ -32,7 +41,7 @@ s3_bucket: your.blog.bucket.com
           retry
         end
       end
-      
+
       def local_files
         Dir[SITE_DIR + '/**/*'].
           delete_if { |f| File.directory?(f) }.
@@ -72,7 +81,7 @@ s3_bucket: your.blog.bucket.com
 
         delete_all = false
         keep_all = false
-        to_delete.each do |f| 
+        to_delete.each do |f|
           delete = false
           keep = false
           until delete || delete_all || keep || keep_all
@@ -104,33 +113,40 @@ s3_bucket: your.blog.bucket.com
       end
 
       # Raise NoConfigurationFileError if the configuration file does not exists
-      # Raise MalformedConfigurationFileError if the configuration file does not contain the keys we expect
-      # Loads the configuration if everything looks cool
       def check_s3_configuration!
         unless File.exists?(CONFIGURATION_FILE)
           create_template_configuration_file
           raise NoConfigurationFileError
         end
-        raise MalformedConfigurationFileError unless load_configuration
       end
 
       # Load configuration from _jekyll_s3.yml
-      # Return true if all values are set and not emtpy
+      # Raise MalformedConfigurationFileError if the configuration file does not contain the keys we expect
       def load_configuration
-        config = YAML.load_file(CONFIGURATION_FILE) rescue nil
-        return false unless config
+        config = load_yaml_file
+        raise MalformedConfigurationFileError unless config
 
         @s3_id = config['s3_id']
         @s3_secret = config['s3_secret']
         @s3_bucket = config['s3_bucket']
+        @cloudfront_distribution_id = config['cloudfront_distribution_id']
 
-        [@s3_id, @s3_secret, @s3_bucket].select { |k| k.nil? || k == '' }.empty?
+        raise MalformedConfigurationFileError unless
+          [@s3_id, @s3_secret, @s3_bucket].select { |k| k.nil? || k == '' }.empty?
       end
 
       def create_template_configuration_file
         File.open(CONFIGURATION_FILE, 'w') { |f| f.write(CONFIGURATION_FILE_TEMPLATE) }
 
       end
+
+      def load_yaml_file
+        begin
+          config = YAML.load_file(CONFIGURATION_FILE)
+        rescue Exception
+          raise MalformedConfigurationFileError
+        end
+      end
     end
   end
 end

data/lib/jekyll-s3/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module S3
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/lib/invalidator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Jekyll::Cloudfront::Invalidator do
+  describe "#invalidate cloudfront items" do
+    it "should retrieve all objects from the S3 bucket and call invalidation on them" do
+      s3_object_keys = ["key1", "key2"]
+      s3_objects = s3_object_keys.map { |key| S3Object.new(key) }
+      @s3_bucket_name = "my-s3-bucket"
+      AWS::S3::Bucket.expects(:find).with(@s3_bucket_name).returns(S3Bucket.new(s3_objects))
+      SimpleCloudfrontInvalidator::CloudfrontClient.any_instance.
+        expects(:invalidate).with(s3_object_keys)
+
+      Jekyll::Cloudfront::Invalidator.invalidate("", "", @s3_bucket_name, "")
+    end
+  end
+end
+
+class S3Bucket
+  def initialize(s3_objects)
+    @s3_objects = s3_objects
+  end
+
+  def objects
+    @s3_objects
+  end
+end
+
+class S3Object
+  def initialize(key)
+    @key = key
+  end
+
+  def key
+    @key
+  end
+end

data/spec/lib/uploader_spec.rb

@@ -1,12 +1,8 @@
-require  File.dirname(__FILE__) + "/../../lib/jekyll-s3.rb"
-
-RSpec.configure do |config|
-  config.mock_framework = :mocha
-end
+require 'spec_helper'
 
 describe Jekyll::S3::Uploader do
   describe "#upload_to_s3" do
-    
+
     before :each do
       AWS::S3::Base.expects(:establish_connection!).at_least(1).returns true
       AWS::S3::Service.expects(:buckets).at_least(1).returns []
@@ -14,20 +10,53 @@ describe Jekyll::S3::Uploader do
       bucket = mock()
       bucket.expects(:objects).returns []
       AWS::S3::Bucket.expects(:find).at_least(1).returns bucket
-      
+
       @uploader = Jekyll::S3::Uploader.new
       @uploader.expects(:local_files).at_least(1).returns ['index.html']
       @uploader.expects(:open).at_least(1).returns true
     end
-    
+
     it "should work right when there are no exceptions" do
       AWS::S3::S3Object.expects(:store).at_least(1).returns(true)
       @uploader.send(:upload_to_s3!).should
     end
-    
+
     it "should properly handle exceptions on uploading to S3" do
       AWS::S3::S3Object.expects(:store).raises(AWS::S3::RequestTimeout.new('timeout', 'timeout')).then.at_least(1).returns(true)
       @uploader.send(:upload_to_s3!).should
     end
   end
-end
+
+  describe "#call_cloudfront_invalidation" do
+    it "should invalidate Cloudfront items if the configuration 'cloudfront_dist_id' exists" do
+      configure_uploader({
+        "s3_id" => "xx",
+        "s3_secret" => "zz",
+        "s3_bucket" => "bucket",
+        "cloudfront_distribution_id" => "dist id"
+      })
+      Jekyll::Cloudfront::Invalidator.expects(:invalidate).with("xx", "zz", "bucket", "dist id")
+      Jekyll::S3::Uploader.run!
+    end
+
+    it "should skip calling Cloudfront if the configuration 'cloudfront_dist_id' is missing" do
+      configure_uploader({
+        "s3_id" => "xx",
+        "s3_secret" => "zz",
+        "s3_bucket" => "bucket"
+      })
+      Jekyll::Cloudfront::Invalidator.expects(:invalidate).never
+      Jekyll::S3::Uploader.run!
+    end
+
+    def configure_uploader(config)
+      def disable_methods_that_interact_with_world
+        Jekyll::S3::Uploader.any_instance.expects(:upload_to_s3!).returns nil
+        Jekyll::S3::Uploader.any_instance.expects(:check_jekyll_project!).returns nil
+        Jekyll::S3::Uploader.any_instance.expects(:check_s3_configuration!).returns nil
+      end
+      YAML.expects(:load_file).with('_jekyll_s3.yml').returns(config)
+      disable_methods_that_interact_with_world
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + "/../lib/jekyll-s3.rb"
+
+RSpec.configure do |config|
+  config.mock_framework = :mocha
+end
+

metadata

@@ -1,150 +1,195 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jekyll-s3
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Philippe Creux
+- Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple-cloudfront-invalidator
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :development
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 4
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-description: Push your jekyll blog to AWS S3
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'This Gem allows you to push your Jekyll blog to AWS S3.
+
+  In addition, you can use this Gem to invalidate the related Cloudfront
+
+  distribution, making it easy to deliver your blog via the CDN.'
+email:
 - pcreux@gmail.com
-executables: 
+- lauri.lehmijoki@iki.fi
+executables:
 - jekyll-s3
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
 - bin/jekyll-s3
+- features/jekyll-s3-cloudfront.feature
 - features/jekyll-s3.feature
 - features/support/env.rb
 - jekyll-s3.gemspec
+- lib/cloudfront/invalidator.rb
 - lib/jekyll-s3.rb
 - lib/jekyll-s3/cli.rb
 - lib/jekyll-s3/errors.rb
 - lib/jekyll-s3/uploader.rb
 - lib/jekyll-s3/version.rb
+- spec/lib/invalidator_spec.rb
 - spec/lib/uploader_spec.rb
-homepage: https://github.com/versapay/jekyll-s3
+- spec/spec_helper.rb
+homepage: https://github.com/laurilehmijoki/jekyll-s3
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 671964648276143186
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 671964648276143186
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Push your jekyll blog to S3"
-test_files: []
-
+summary: Push your Jekyll blog to S3
+test_files:
+- features/jekyll-s3-cloudfront.feature
+- features/jekyll-s3.feature
+- features/support/env.rb
+- spec/lib/invalidator_spec.rb
+- spec/lib/uploader_spec.rb
+- spec/spec_helper.rb