middleman-cdn 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c69df7b602f0dab070c27d9c0ad63b7b91a6c0b
-  data.tar.gz: 0bd77eba0b7256212615c526de25f04d8dc2d250
+  metadata.gz: 69067babbcf6c181de78867c0a26cd0419f1cd7f
+  data.tar.gz: 9a2adde88d7fce458d9c04d29dd48728403c708d
 SHA512:
-  metadata.gz: 7d713c1b93db2a90b5be5472ab9be51dbc381fce5c32e3546569e383edb34b92330d7db6a945a2daab393fbb5799a15bbb381915fa93dd3a26a7b8df896d860f
-  data.tar.gz: ad09374e358f9e36be4aa94555ca6254f4572a0616bcf3a8beffc2c0d21c532243c8a2add8bd8f132c65ae5f115350539136f778ab07c6b2380db30505f05311
+  metadata.gz: 1f353a06b8b40e21e040c5797c504f15afe500b5264ea476e91ba587f7ea26e2e8114aac2bfc9bea10f03c5dab5886d7630cca98ecbc6534557268154c9b01ac
+  data.tar.gz: 2627680904f589d2901a5732549c19105ea017dcbafcac74f986efd57f1747c3e1ab194f0d8bba957c8fa0d1c848ab695b818eb380fe64ea84e6e8aa3a8eb835

data/README.md

@@ -1,22 +1,20 @@
 # Middleman CDN [![Build Status](https://travis-ci.org/leighmcculloch/middleman-cdn.svg)](https://travis-ci.org/leighmcculloch/middleman-cdn) [![Dependency Status](https://gemnasium.com/leighmcculloch/middleman-cdn.png)](https://gemnasium.com/leighmcculloch/middleman-cdn)
-A deploying tool for middleman which allows you to invalidate resources cached
-on the CloudFlare and Amazon CloudFront CDNs. Specifically useful if your
-using multiple CDNs to cache the content of your middleman website.
+A [middleman](http://middlemanapp.com/) deploy tool for invalidating resources cached
+on common Content Delivery Networks (CDNs).
 
 * Cache invalidation of files on:
   * CloudFlare
   * Amazon CloudFront
-  * **Use another CDN? Open an issue and I'll do it.**
-* Invalidate files on multiple CDNs.
-* Call from the command line.
-* Call automatically after middleman build.  
-* Ability to select/filter files to be invalidated by regex.  
+* Select files for invalidation with regex.  
+* Automatically invalidate after build.
+* Manually trigger invalidation with single command.
 
 What's next?
 
 * Expand the test base.
 * Add support for Fastly.
 * Add support for MaxCDN.
+* [Open an issue](../../issues/new) if you'd like your CDN provider added.
 
 # Usage
 
@@ -33,15 +31,20 @@ bundle install
 
 ## Configuration
 
-Edit `config.rb` and add the following. Specify either one CDN config or
-multiple.  
+Edit your middleman `config.rb` and add the following. Specify either one or
+more CDN configurations.
 ```ruby
 activate :cdn do |cdn|
   cdn.cloudflare = {
-    client_api_key: '...',         # default ENV['CLOUDFLARE_CLIENT_API_KEY']
-    email: 'you@example.com',      # default ENV['CLOUDFLARE_EMAIL']
+    client_api_key: '...',          # default ENV['CLOUDFLARE_CLIENT_API_KEY']
+    email: 'you@example.com',       # default ENV['CLOUDFLARE_EMAIL']
     zone: 'example.com',
-    base_urls: ['http://example.com', 'https://example.com']
+    base_urls: [
+      'http://example.com',
+      'http://www.example.com',
+      'https://example.com',
+      'https://www.example.com'
+    ]
   }
   cdn.cloudfront = {
     access_key_id: '...',           # default ENV['AWS_ACCESS_KEY_ID']
@@ -49,12 +52,67 @@ activate :cdn do |cdn|
     distribution_id: '...'
   }
   cdn.filter            = /\.html/i # default /.*/
-  cdn.after_build       = true     # default is false
+  cdn.after_build       = true      # default is false
 end
 ```
 
-Instead of storing your CDN credentials in config.rb store them in the
-environment variables specified above, or execute on the commandline as:
+### Configuration: Filter
+
+The `filter` parameter defines which files in your middleman `build` directory
+will be invalidated on the CDN. It must be a regular expression (use
+[rubular](http://rubular.com/) to test your regex).  
+
+Examples:
+
+| Files         | Regex         |
+|:------------- |:------------- |
+| HTML files    | `/\.html$/i`  |
+| All files     | `/.*/`        |
+
+It's better to always invalidate only the files you need. If you're using
+[middleman's asset pipeline](http://middlemanapp.com/basics/asset-pipeline/) to
+generate fingerprinted CSS, JS and images, then you should never need to
+invalidate them.
+
+Note: Directories containing `index.html` files are automatically included
+when their respective `index.html` is included in the filter.
+
+### Configuration: CloudFlare
+
+The `cloudflare` parameter contains the information specific to your CloudFlare
+account and which zone (domain) files should be invalidated for. CloudFlare
+invalidation works off URLs not filenames, and you must provide a list of
+base urls to ensure we invalidate every URL that your files might be accessed
+from.
+
+| Parameter | Description |
+|:--------- |:----------- |
+| `client_api_key` | You can find this by logging into CloudFlare, going to your account page and it will be down the bottom left. |
+| `email` | The email address that you use to login to CloudFlare with. |
+| `zone` | The domain name of the website we are invalidating. |
+| `base_urls` | An array of base URLs that the files are accessible at. |
+
+CloudFlare invalidations take mere seconds.
+
+### Configuration: CloudFront
+
+The `cloudfront` parameter contains the information specific to your AWS CloudFront
+account and which distribution files should be invalidated for.
+
+| Parameter | Description |
+|:--------- |:----------- |
+| `access_key_id` | AWS Access Key ID (generate in AWS Console IAM) |
+| `secret_access_key` | AWS Secret Access Key (generate in AWS Console IAM) |
+| `distribution_id` | The distribution ID on the CloudFront distribution. |
+
+CloudFront invalidations take up to 15 minutes. You can monitor the progress of
+the invalidation in your AWS Console.
+
+### Credentials via Environment Variables
+
+Instead of storing your CDN credentials in config.rb where they may be public
+on github, store them in environment variables, or execute on the
+commandline as:
 
 ```bash
 CLOUDFLARE_CLIENT_API_KEY= CLOUDFLARE_EMAIL= AWS_ACCESS_KEY= AWS_SECRET= bundle exec middleman invalidate
@@ -67,19 +125,20 @@ Set `after_build` to `true` and the cache will be invalidated after build:
 bundle exec middleman build
 ```
 
-Otherwise, invalidate manually using:  
+Invalidate manually using:  
 ```bash
 bundle exec middleman invalidate
 ```
 
-Or, shorthand:  
+Or:
 ```bash
 bundle exec middleman inv
 ```
 
-## In the wild
+## Example Usage
 
-I'm using middleman-cdn on my personal website leighmcculloch.com on github.
+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. Unlike CloudFront, CloudFlare doesn't default to caching HTML. Configure a PageRule that looks like this to tell CloudFlare's edge to cache everything.  
+![CloudFlare PageRule Example](README-cloudflare-pagerule-example.png)
 
 ## Thanks
 
@@ -87,4 +146,8 @@ Middleman CDN is a fork off [Middleman CloudFront](https://github.com/andrusha/m
 
 Thanks to @b4k3r for the [Cloudflare gem](https://github.com/b4k3r/cloudflare) that made invalidating CloudFlare files a breeze.
 
-Thanks to @cloudflare for CloudFlare.
+## Why Middleman CDN
+
+Middleman CloudFront is a great extension for Middleman and perfect if you're using CloudFront. I use CloudFlare primarily and I wanted to create a similar extension for it specifically. However, it's becoming increasingly common for static websites to be hosted across multiple CDNs. [jsDelivr](http://jsdelivr.com/) is a well known promoter of this strategy.  
+
+In light of the new trends in how we are using CDNs, I decided it would be more worthwhile to create an extension that can grow to support all the popular CDNs.

data/lib/middleman-cdn/extension.rb

@@ -17,13 +17,15 @@ module Middleman
       def initialize(app, options_hash = {}, &block)
         super
 
-        app.after_build do
-          ::Middleman::Cli::CDN.new.invalidate(options) if options.after_build
+        @@cdn_options = options
+
+        app.after_configuration do
+          app.after_build do
+            ::Middleman::Cli::CDN.new.invalidate(@@cdn_options) if @@cdn_options.after_build
+          end
         end
 
         app.send :include, Helpers
-
-        @@cdn_options = options
       end
 
       def registered

data/lib/middleman-cdn/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module CDN
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-cdn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Leigh McCulloch
@@ -161,6 +161,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
+- README-cloudflare-pagerule-example.png
 - README.md
 - Rakefile
 - features/support/env.rb