middleman-cloudfront 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86426bb088d94149e2d8a94a151a9cdebfe56124
-  data.tar.gz: 661a5dababcb3690b5af7b910a241428f3784a9b
+  metadata.gz: 12348384796b7067046a25f423794d619a66e943
+  data.tar.gz: 8aa2e82b808ca93d29e33104a40fbe5715937150
 SHA512:
-  metadata.gz: 4f75b4a87b8c0d7545d2d88500bc58df6c986a5614ba8fc1488c0f4b51d54468156da7fa4fcee2a7bbf79eee78255627afc5077dc33e5a6bb63b73deee739561
-  data.tar.gz: 70b64829e5a60b459ad7e77d4802591d7a4a42456946798165e27ae91ea7a406c2a7b4df30b10c96e1ba87892a5e427ae228b1b204d7a27c7b100daef50962e2
+  metadata.gz: 0837f2f566cf23f9ac6c33f0fdc76c72ed414da0740d8fa3e7ea8bc3d5a91e2fc4638c2d9fec7445773f8864d8ac2a68ae9aee836931f104402ff3d98836038d
+  data.tar.gz: 0ba79f208ec3c2ce644d5c040338c57dd94b4329bd5139d237d3d989a3fad55589dcd8a61f769728e618d299a33faa215b77d016a0aa356175bcdd571eaebd74

data/README.md

@@ -32,6 +32,26 @@ activate :cloudfront do |cf|
 end
 ```
 
+On Amazon use following parameters inside your IAM policy:
+```
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "Stmt1409254980000",
+      "Effect": "Allow",
+      "Action": [
+        "cloudfront:CreateInvalidation",
+        "cloudfront:GetDistribution"
+      ],
+      "Resource": [
+        "*"
+      ]
+    }
+  ]
+}
+```
+
 ## Running
 
 If you set `after_build` to `true` cache would be automatically invalidated after build:  
@@ -44,6 +64,16 @@ Otherwise you should run it through commandline interface like so:
 bundle exec middleman invalidate
 ```
 
+or from within Middleman, optionally specifying a list of files to invalidate:
+
+```ruby
+# Invalidate automatic selection of files from build directory
+invalidate
+
+# Invalidate explicit list of files
+invalidate %w(/index.html /images/example.png)
+```
+
 ## S3 + Cloudfront deploying
 
 In real world this gem shouldn't be used alone, but as a part of your 
@@ -78,3 +108,10 @@ And when I want to deploy my site I do:
 AWS_ACCESS_KEY= AWS_SECRET= bundle exec middleman sync
 AWS_ACCESS_KEY= AWS_SECRET= bundle exec middleman invalidate
 ```
+
+If you use [middleman-s3_sync](https://github.com/fredjean/middleman-s3_sync) for deployment, you can use its `after_s3_sync` hook to automatically invalidate updated files after syncing:
+```ruby
+after_s3_sync do |files_by_status|
+  invalidate files_by_status[:updated]
+end
+```

data/Rakefile

@@ -9,29 +9,6 @@ Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
   t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
 end
 
-require 'rake/clean'
-
-require "middleman-cloudfront/pkg-info"
-
-PACKAGE = "#{Middleman::CloudFront::PACKAGE}"
-VERSION = "#{Middleman::CloudFront::VERSION}"
-
-task :package do
-  system "gem build #{PACKAGE}.gemspec"
-end
-
-task :install => :package do
-  Dir.chdir("pkg") do
-    system "gem install #{PACKAGE}-#{VERSION}"
-  end
-end
-
-task :release => :package do
-  Dir.chdir("pkg") do
-    system "gem push #{PACKAGE}-#{VERSION}"
-  end
-end
-
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/middleman-cloudfront/commands.rb

@@ -18,8 +18,8 @@ module Middleman
         true
       end
 
-      desc "cloudfront:invalidate", "A way to deal with your ClodFront distributions"
-      def invalidate(options = nil)
+      desc "invalidate", "A way to deal with your CloudFront distributions"
+      def invalidate(options = nil, files = nil)
         if options.nil?
           app_instance = ::Middleman::Application.server.inst
           unless app_instance.respond_to?(:cloudfront_options)
@@ -55,7 +55,7 @@ end
         # CloudFront limits the amount of files which can be invalidated by one request to 1000.
         # If there are more than 1000 files to invalidate, do so sequentially and wait until each validation is ready.
         # If there are max 1000 files, create the invalidation and return immediately.
-        files = list_files(options.filter)
+        files = normalize_files(files || list_files(options.filter))
         return if files.empty?
 
         if files.count <= INVALIDATION_LIMIT
@@ -84,20 +84,19 @@ end
 
             # Remove files that do not match filter
             files.reject! { |f| f !~ filter }
-
-            # Add directories of index.html files since they have to be
-            # invalidated as well if :directory_indexes is active
-            files.each do |file|
-              file_dir = file.sub(/\bindex\.html\z/, '')
-              files << file_dir if file_dir != file
-            end
-
-            # Add leading slash
-            files.map! { |f| f.start_with?('/') ? f : "/#{f}" }
           end
         end
       end
 
+      def normalize_files(files)
+        # Add directories since they have to be invalidated
+        # as well if :directory_indexes is active
+        files += files.grep(/\/index.html\z/).map { |file| File.dirname(file) << '/' }.uniq
+
+        # URI encode and add leading slash
+        files.map { |f| URI::encode(f.start_with?('/') ? f : "/#{f}") }
+      end
+
     end
 
     Base.map({"inv" => "invalidate"})

data/lib/middleman-cloudfront/extension.rb

@@ -26,6 +26,10 @@ module Middleman
       def cloudfront_options
         ::Middleman::CloudFront.options
       end
+
+      def invalidate(files = nil)
+        ::Middleman::Cli::CloudFront.new.invalidate(cloudfront_options, files)
+      end
     end
 
   end

data/lib/middleman-cloudfront/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module CloudFront
+    VERSION = '0.1.0'
+  end
+end

data/middleman-cloudfront.gemspec

@@ -1,9 +1,12 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "middleman-cloudfront/pkg-info"
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'middleman-cloudfront/version'
 
 Gem::Specification.new do |s|
-  s.name        = Middleman::CloudFront::PACKAGE
+  s.name        = 'middleman-cloudfront'
   s.version     = Middleman::CloudFront::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Andrey Korzhuev", "Manuel Meurer"]

data/spec/lib/middleman-cloudfront/commands_spec.rb

@@ -17,24 +17,30 @@ describe Middleman::Cli::CloudFront do
 
   describe '#invalidate' do
     before do
-      Fog::CDN::AWS::Distributions.any_instance.stub(:get).and_return(distribution)
-      distribution.invalidations.stub(:create) do
-        double('invalidation', status: 'InProgress', wait_for: ->{} )
+      allow_any_instance_of(Fog::CDN::AWS::Distributions).to receive(:get).and_return(distribution)
+      allow(distribution.invalidations).to receive(:create) do
+        double('invalidation', status: 'InProgress', wait_for: -> {})
       end
     end
 
     it 'gets the correct distribution' do
-      cloudfront.stub(:list_files).and_return []
+      allow(cloudfront).to receive(:list_files).and_return([])
       expect_any_instance_of(Fog::CDN::AWS::Distributions).to receive(:get).with('distribution_id_123')
       cloudfront.invalidate(options)
     end
 
+    it 'normalizes paths' do
+      files = %w(file directory/index.html)
+      normalized_files = %w(/file /directory/index.html /directory/)
+      allow(cloudfront).to receive(:list_files).and_return(files)
+      expect(distribution.invalidations).to receive(:create).once.with(paths: normalized_files)
+      cloudfront.invalidate(options)
+    end
+
     context 'when the amount of files to invalidate is under the limit' do
       it 'divides them up in packages and creates one invalidation per package' do
-        files = (1..Middleman::Cli::CloudFront::INVALIDATION_LIMIT).map do |i|
-          "file_#{i}"
-        end
-        cloudfront.stub(:list_files).and_return files
+        files = (1..Middleman::Cli::CloudFront::INVALIDATION_LIMIT).map { |i| "/file_#{i}" }
+        allow(cloudfront).to receive(:list_files).and_return(files)
         expect(distribution.invalidations).to receive(:create).once.with(paths: files)
         cloudfront.invalidate(options)
       end
@@ -42,15 +48,35 @@ describe Middleman::Cli::CloudFront do
 
     context 'when the amount of files to invalidate is over the limit' do
       it 'creates only one invalidation with all of them' do
-        files = (1..(Middleman::Cli::CloudFront::INVALIDATION_LIMIT * 3)).map do |i|
-          "file_#{i}"
-        end
-        cloudfront.stub(:list_files).and_return files
+        files = (1..(Middleman::Cli::CloudFront::INVALIDATION_LIMIT * 3)).map { |i| "/file_#{i}" }
+        allow(cloudfront).to receive(:list_files).and_return(files)
         expect(distribution.invalidations).to receive(:create).once.with(paths: files[0, Middleman::Cli::CloudFront::INVALIDATION_LIMIT])
         expect(distribution.invalidations).to receive(:create).once.with(paths: files[Middleman::Cli::CloudFront::INVALIDATION_LIMIT, Middleman::Cli::CloudFront::INVALIDATION_LIMIT])
         expect(distribution.invalidations).to receive(:create).once.with(paths: files[Middleman::Cli::CloudFront::INVALIDATION_LIMIT * 2, Middleman::Cli::CloudFront::INVALIDATION_LIMIT])
         cloudfront.invalidate(options)
       end
     end
+
+    context 'when files to invalidate are explicitly specified' do
+      it 'uses them instead of the files in the build directory' do
+        files = (1..3).map { |i| "/file_#{i}" }
+        expect(distribution.invalidations).to receive(:create).once.with(paths: files)
+        cloudfront.invalidate(options, files)
+      end
+
+      it "doesn't filter them" do
+        files = (1..3).map { |i| "/file_#{i}" }
+        options.filter = /filter that matches no files/
+        expect(distribution.invalidations).to receive(:create).once.with(paths: files)
+        cloudfront.invalidate(options, files)
+      end
+
+      it 'normalizes them' do
+        files = %w(file directory/index.html)
+        normalized_files = %w(/file /directory/index.html /directory/)
+        expect(distribution.invalidations).to receive(:create).once.with(paths: normalized_files)
+        cloudfront.invalidate(options, files)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'middleman-cloudfront'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-cloudfront
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrey Korzhuev
@@ -9,118 +9,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: fivemat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !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
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Adds ability to invalidate a specific set of files in your CloudFront
@@ -131,8 +131,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -142,7 +142,7 @@ files:
 - lib/middleman-cloudfront.rb
 - lib/middleman-cloudfront/commands.rb
 - lib/middleman-cloudfront/extension.rb
-- lib/middleman-cloudfront/pkg-info.rb
+- lib/middleman-cloudfront/version.rb
 - lib/middleman_extension.rb
 - middleman-cloudfront.gemspec
 - spec/lib/middleman-cloudfront/commands_spec.rb
@@ -156,17 +156,17 @@ 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: []
 rubyforge_project: middleman-cloudfront
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Invalidate CloudFront cache after deployment to S3

data/lib/middleman-cloudfront/pkg-info.rb

@@ -1,6 +0,0 @@
-module Middleman
-  module CloudFront
-    PACKAGE = 'middleman-cloudfront'
-    VERSION = '0.0.9'
-  end
-end