middleman-cdn 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8550558e8e045e9d7f82f7b54b44a8a41dca5077
-  data.tar.gz: bbf9bf9ee078a2f6ed00edf5e5461abf3ff183aa
+  metadata.gz: 7c8c316517f0c2673b971da4bfb0c637cb09b9a4
+  data.tar.gz: c68675ee11af145c82dd4e64a72135baa5522d0d
 SHA512:
-  metadata.gz: 459ed7ed549ffead8d05e497d2b1036d48416efaf5cce161fa8ed51ce773a6ad4a69711c51aecfb26649fb4efad7c66183113008f51ca365f7ea32476231ccc0
-  data.tar.gz: dcef7018c3c2141b8f36baae317272931b250886c3d17ffbbfc07d7be2102f72971f251db38503d972372c3965417af3ac42448794f97a332bcf5f3f72de6791
+  metadata.gz: a490b5271e455b88f523cc937c58d7a55e29fdf0f0b321d5ad5ff24fd1913898268e7bc985e7b5904cc3bb2ca327c1adf501c6b5b630c7d2df8b5e94a59fac21
+  data.tar.gz: aea229478874d90b8f0c3526c557daada1066b581e9cd7b8c9f99b5c16170aed949f92fdba11eb9a956cf57b092cdfaa33936072fab5d8fa83da42382ae6f31f

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.0
-  - 2.1.2
+  - 2.1.5
+  - 2.2.1

data/README.md

@@ -14,15 +14,13 @@ on common Content Delivery Networks (CDNs).
   * [Rackspace CloudFiles](http://www.rackspace.com/cloud/files/)
 * Select files for invalidation with regex.  
 * Automatically invalidate after build.
-* Manually trigger invalidation with a single command.
-
-What's next?
-* Invalidating files only when they've changed.
-* [Open an issue](../../issues/new) if you'd like your CDN provider added.
+* Manually trigger invalidation with a single command on specific files.
+* Invalidating files only when they've changed [if you're using middleman-s3_sync](#invalidating-with-middleman-s3_sync).
 
 # Usage
 
 ## Installation
+
 Add this to your `Gemfile`:  
 ```ruby
 gem "middleman-cdn"
@@ -99,6 +97,9 @@ invalidate them.
 Note: Directories containing `index.html` files are automatically included
 when their respective `index.html` is included in the filter.
 
+Alternatively: If you're using `middleman-s3_sync` you can hook middleman-cdn into 
+it's build process. See the [instructions here](#invalidating-with-middleman-s3_sync).
+
 ### Configuration: CloudFlare
 
 The `cloudflare` parameter contains the information specific to your CloudFlare
@@ -194,7 +195,6 @@ as environment variables or provided on the commandline like this example.
 CLOUDFLARE_CLIENT_API_KEY= CLOUDFLARE_EMAIL= bundle exec middleman invalidate
 ```
 
-
 ## Invalidating
 
 Set `after_build` to `true` and the cache will be invalidated after build:  
@@ -204,14 +204,25 @@ bundle exec middleman build
 
 Or, invalidate manually using:  
 ```bash
-bundle exec middleman cdn_invalidate
+bundle exec middleman cdn
 ```
 
-Or:
+Or, invalidate specific files manually:
 ```bash
-bundle exec middleman cdn
+bundle exec middleman cdn [file] [file] ...
 ```
 
+## Invalidating with middleman-s3_sync
+
+If you're using `middleman-s3_sync` you can hook middleman-cdn into it's build process, to invalidate only the files that s3_sync uploads. Add the following to your `config.rb`:
+```ruby
+after_s3_sync do |files_by_status|
+  cdn_invalidate(files_by_status[:updated])
+end
+```
+
+Also, make sure to remove `cdn.after_build = true` from your config, if it was there previously, so the invalidation is not run twice.
+
 ## Example Usage
 
 I'm using middleman-cdn on my personal website [leighmcculloch.com](http://leighmcculloch.com) which is on [github](https://github.com/leighmcculloch/leighmcculloch.com) if you want to checkout how I deploy. It's configuration has all of the above CDNs in use for demonstration. I primarily use CloudFlare, and unlike the other CDNs, CloudFlare doesn't default to caching HTML. To make the most of CloudFlare, configure a PageRule that looks like this to tell CloudFlare to cache everything.  

data/lib/middleman-cdn/cdns/cloudflare.rb

@@ -25,14 +25,14 @@ module Middleman
 
         [:client_api_key, :email, :zone, :base_urls].each do |key|
           if options[key].blank?
-            say_status("Error: Configuration key cloudflare[:#{key}] is missing.".red)
+            say_status(ANSI.red{ "Error: Configuration key cloudflare[:#{key}] is missing." })
             raise
           end
         end
 
         options[:base_urls] = [options[:base_urls]] if options[:base_urls].is_a?(String)
         if !options[:base_urls].is_a?(Array)
-          say_status("Error: Configuration key cloudflare[:base_urls] must be an array and contain at least one base url.".red)
+          say_status(ANSI.red{ "Error: Configuration key cloudflare[:base_urls] must be an array and contain at least one base url." })
           raise
         end
 
@@ -42,9 +42,9 @@ module Middleman
             say_status("Invalidating zone #{options[:zone]}... ", newline: false)
             cloudflare.fpurge_ts(options[:zone])
           rescue => e
-            say_status(", " + "error: #{e.message}".red, header: false)
+            say_status(", " + ANSI.red{ "error: #{e.message}" }, header: false)
           else
-            say_status("✔".green, header: false)
+            say_status(ANSI.green{ "✔" }, header: false)
           end
         else
           options[:base_urls].each do |base_url|
@@ -54,9 +54,9 @@ module Middleman
                 say_status("Invalidating #{url}... ", newline: false)
                 cloudflare.zone_file_purge(options[:zone], "#{base_url}#{file}")
               rescue => e
-                say_status(", " + "error: #{e.message}".red, header: false)
+                say_status(", " + ANSI.red{ "error: #{e.message}" }, header: false)
               else
-                say_status("✔".green, header: false)
+                say_status(ANSI.green{ "✔" }, header: false)
               end
             end
           end

data/lib/middleman-cdn/cdns/cloudfront.rb

@@ -24,7 +24,7 @@ module Middleman
         options[:secret_access_key] ||= ENV['AWS_SECRET_ACCESS_KEY']
         [:access_key_id, :secret_access_key, :distribution_id].each do |key|
           if options[key].blank?
-            say_status("Error: Configuration key cloudfront[:base_urls] is missing.".red)
+            say_status(ANSI.red{ "Error: Configuration key cloudfront[:base_urls] is missing." })
             raise
           end
         end
@@ -41,10 +41,10 @@ module Middleman
           say_status("Invalidating #{files.count} files... ", newline: false)
           invalidation = distribution.invalidations.create(:paths => files)
           if invalidation.status != 'InProgress'
-            say_status("Invalidation status is #{invalidation.status}. Expected 'InProgress'.".red.bold, header: false)
+            say_status(ANSI.red{ ANSI.bold + "Invalidation status is #{invalidation.status}. Expected 'InProgress'." }, header: false)
             raise
           end
-          say_status("✔".green, header: false)
+          say_status(ANSI.green{ "✔" }, header: false)
         else
           slices = files.each_slice(INVALIDATION_LIMIT)
           say_status("Invalidating #{files.count} files in #{slices.count} batch(es) ")
@@ -52,7 +52,7 @@ module Middleman
             say_status("Invalidating batch #{i + 1}... ", newline: false)
             invalidation = distribution.invalidations.create(:paths => slice)
             invalidation.wait_for { ready? } unless i == slices.count - 1
-            say_status("✔".green, header: false)
+            say_status(ANSI.green{ "✔" }, header: false)
           end
         end
         say_status("It might take 10 to 15 minutes until all files are invalidated.")

data/lib/middleman-cdn/cdns/fastly.rb

@@ -22,14 +22,14 @@ module Middleman
 
         [:api_key, :base_urls].each do |key|
           if options[key].blank?
-            say_status("Error: Configuration key fastly[:#{key}] is missing.".red)
+            say_status(ANSI.red{ "Error: Configuration key fastly[:#{key}] is missing." })
             raise
           end
         end
 
         options[:base_urls] = [options[:base_urls]] if options[:base_urls].is_a?(String)
         if !options[:base_urls].is_a?(Array)
-          say_status("Error: Configuration key fastly[:base_urls] must be an array and contain at least one base url.".red)
+          say_status(ANSI.red{ "Error: Configuration key fastly[:base_urls] must be an array and contain at least one base url." })
           raise
         end
 
@@ -44,9 +44,9 @@ module Middleman
               say_status("Invalidating #{url}... ", newline: false)
               fastly.purge("#{base_url}#{file}")
             rescue => e
-              say_status(", " + "error: #{e.message}".red, header: false)
+              say_status(ANSI.red{ ", " + "error: #{e.message}" }, header: false)
             else
-              say_status("✔".green, header: false)
+              say_status(ANSI.green{ "✔" }, header: false)
             end
           end
         end

data/lib/middleman-cdn/cdns/maxcdn.rb

@@ -26,7 +26,7 @@ module Middleman
 
         [:alias, :consumer_key, :consumer_secret, :zone_id].each do |key|
           if options[key].blank?
-            say_status("Error: Configuration key maxcdn[:#{key}] is missing.".red)
+            say_status(ANSI.red{ "Error: Configuration key maxcdn[:#{key}] is missing." })
             raise
           end
         end
@@ -37,9 +37,9 @@ module Middleman
           say_status("Invalidating #{files.count} files...", newline: false)
           maxcdn.purge(options[:zone_id], files)
         rescue => e
-          say_status(", " + "error: #{e.message}".red, header: false)
+          say_status(ANSI.red{ ", " + "error: #{e.message}" }, header: false)
         else
-          say_status("✔".green, header: false)
+          say_status(ANSI.green{ "✔" }, header: false)
         end
       end
     end

data/lib/middleman-cdn/cdns/rackspace.rb

@@ -28,7 +28,7 @@ module Middleman
 
         [:username, :api_key, :region, :container].each do |key|
           if options[key].blank?
-            say_status("Error: Configuration key rackspace[:#{key}] is missing.".red)
+            say_status(ANSI.red{ "Error: Configuration key rackspace[:#{key}] is missing." })
             raise
           end
         end
@@ -54,9 +54,9 @@ module Middleman
           say_status("Invalidating #{file}...", newline: false)
           rackspace_client.invalidate(region, container, file, notification_email: notification_email)
         rescue => e
-          say_status(" error: #{e.message}".red, header: false)
+          say_status(ANSI.red{ " error: #{e.message}" }, header: false)
         else
-          say_status("✔".green, header: false)
+          say_status(ANSI.green{ "✔" }, header: false)
         end
       end
     end

data/lib/middleman-cdn/commands.rb

@@ -6,7 +6,7 @@ require "middleman-cdn/cdns/cloudfront.rb"
 require "middleman-cdn/cdns/fastly.rb"
 require "middleman-cdn/cdns/maxcdn.rb"
 require "middleman-cdn/cdns/rackspace.rb"
-require "colorize"
+require "ansi/code"
 
 module Middleman
   module Cli
@@ -35,7 +35,7 @@ module Middleman
           if options.nil?
             app_instance = ::Middleman::Application.server.inst
             unless app_instance.respond_to?(:cdn_options)
-              self.class.say_status(nil, "Error: You need to activate the cdn extension in config.rb.\n#{example_configuration}".red)
+              self.class.say_status(nil, ANSI.red{ "Error: You need to activate the cdn extension in config.rb.\n#{example_configuration}" })
               raise
             end
             options = app_instance.cdn_options
@@ -43,7 +43,7 @@ module Middleman
           options.filter ||= /.*/
 
           if cdns.all? { |cdn| options.public_send(cdn.key.to_sym).nil? }
-            self.class.say_status(nil, "Error: You must specify a config for one of the supported CDNs.\n#{example_configuration}".red)
+            self.class.say_status(nil, ANSI.red{ "Error: You must specify a config for one of the supported CDNs.\n#{example_configuration}" })
             raise
           end
 
@@ -72,7 +72,7 @@ module Middleman
 
       def self.say_status(cdn, status, newline: true, header: true, wait_enter: false)
         message = ""
-        message << "#{:cdn.to_s.rjust(12).green}  #{cdn.try(:yellow)}" if header
+        message << "#{ANSI.green { :cdn.to_s.rjust(12)} }  #{ANSI.yellow{ cdn } unless cdn.nil? }" if header
         message << " " if header && cdn
         message << status if status
         print message

data/lib/middleman-cdn/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module CDN
-    VERSION = '0.1.13'
+    VERSION = '0.1.14'
   end
 end

data/middleman-cdn.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'cloudflare', '~> 2.0'
   s.add_dependency 'fastly', '~> 1.1'
   s.add_dependency 'maxcdn', '~> 0.1'
-  s.add_dependency 'colorize', '~> 0.7'
+  s.add_dependency 'ansi', '~> 1.5'
   s.add_dependency 'activesupport', '~> 4.1'
   s.add_dependency 'httparty', '~> 0.13'
 

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

@@ -15,6 +15,12 @@ describe Middleman::Cli::CDN do
         described_class.say_status(nil, "a status")
       end
     end
+
+    context "with a cdn" do 
+      it "should say" do
+        described_class.say_status("the cdn", "a status")
+      end
+    end
   end
 
   describe '#cdn_invalidate' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-cdn
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Leigh McCulloch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Invalidate CloudFlare or CloudFront cache after deployment