middleman-cdn 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7df50ddbc16cbcc2aad12f23bc81f594664f71c
-  data.tar.gz: 2bbb29162f24ed5fb9470847460b3052612ed87b
+  metadata.gz: c0db2d194f1dd93aea915bd2a954c977f24678d4
+  data.tar.gz: c59dc210e2d7a273e5255a85376d283496b0d6d5
 SHA512:
-  metadata.gz: 6413c23a7d9080e4846e2c73db67736aa03292567b2e85e6d3ee35ba8468f5a0fe27b11ea2bd4d152136a926317019176da5211e402a961dea6a9529b19495c7
-  data.tar.gz: 70f29c73716425f684dabf4887fcb262362912de4f5e22b0751412a0fba1a7363297ca845960dbb20092367549291826b72f96f6a6199079cb35a08193a538c9
+  metadata.gz: a4f961344e60c4297417cc6152b0673387d44c786f8b505c5b0a4c68d44523a2dcb0fa2ffc184e2c29574c14c3d7bf2189d1abd5048512396edddacf3cb049c1
+  data.tar.gz: e586736630bf84c1d6eccd1eb997671f6cfc162f2f26f034952346cf1bb66e0b6ddae7a962461b799430d3af174cbabed46f18594b5894550d6d9b9d55bfc96d

data/README.md

@@ -1,19 +1,22 @@
 # 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)
+
+** Build status failing due to [RubyGem's dependency issues affecting some gems](https://twitter.com/rubygems_status/statuses/489119131862462464). Tests do pass.
+
 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
+  * [CloudFlare](https://cloudflare.com)
+  * [Fastly](https://fastly.com)
+  * [Amazon CloudFront](http://aws.amazon.com/cloudfront/)
 * 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.
+* Add support for RackspaceCDN (Akamai).
 * [Open an issue](../../issues/new) if you'd like your CDN provider added.
 
 # Usage
@@ -41,11 +44,16 @@ activate :cdn do |cdn|
     zone: 'example.com',
     base_urls: [
       'http://example.com',
-      'http://www.example.com',
       'https://example.com',
-      'https://www.example.com'
     ]
   }
+  cdn.fastly = {
+    api_key: '...',                 # default ENV['FASTLY_API_KEY']
+    base_urls: [
+      'http://www.example.com',
+      'https://www.example.com'
+    ],
+  }
   cdn.cloudfront = {
     access_key_id: '...',           # default ENV['AWS_ACCESS_KEY_ID']
     secret_access_key: '...',       # default ENV['AWS_SECRET_ACCESS_KEY']
@@ -83,7 +91,7 @@ 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.
+at.
 
 | Parameter | Description |
 |:--------- |:----------- |
@@ -92,7 +100,21 @@ from.
 | `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.
+CloudFlare invalidations often take a few seconds.
+
+### Configuration: Fastly
+
+The `fastly` parameter contains the information specific to your Fastly
+account. Fastly 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
+at.
+
+| Parameter | Description |
+|:--------- |:----------- |
+| `api_key` | You can find this by logging into Fastly, going to your account page and it will be on the left. |
+| `base_urls` | An array of base URLs that the files are accessible at. |
+
+Fastly invalidations often take a few seconds.
 
 ### Configuration: CloudFront
 
@@ -115,7 +137,7 @@ 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
+CLOUDFLARE_CLIENT_API_KEY= CLOUDFLARE_EMAIL= FASTLY_API_KEY= AWS_ACCESS_KEY= AWS_SECRET= bundle exec middleman invalidate
 ```
 
 ## Invalidating
@@ -148,6 +170,6 @@ Thanks to @b4k3r for the [Cloudflare gem](https://github.com/b4k3r/cloudflare) t
 
 ## 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.  
+Middleman CloudFront is a great extension for Middleman and perfect if you're using CloudFront. I needed a similar extension for CloudFlare, 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/cdns/base.rb

@@ -4,7 +4,7 @@ module Middleman
     class BaseCDN
       def self.example_configuration
         config_lines = self.example_configuration_elements.map do |config_key, config_info|
-          "    #{config_key.to_s}: #{config_info[0]}".ljust(30) + " #{config_info[1]}"
+          "    #{config_key.to_s}: #{config_info[0]},".ljust(30) + " #{config_info[1]}"
         end
 
         <<-TEXT

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

@@ -0,0 +1,57 @@
+#Encoding: UTF-8
+require "fastly"
+require "active_support/core_ext/string"
+
+module Middleman
+  module Cli
+
+    class FastlyCDN < BaseCDN
+      def self.key
+        "fastly"
+      end
+
+      def self.example_configuration_elements
+        {
+          api_key: ['"..."', "# default ENV['FASTLY_API_KEY']"],
+          base_urls: [['http://www.example.com', 'https://www.example.com'], ""]
+        }
+      end
+
+      def invalidate(options, files)
+        options[:api_key] ||= ENV['FASTLY_API_KEY']
+
+        [:api_key, :base_urls].each do |key|
+          if options[key].blank?
+            say_status("Error: Configuration key fastly[:#{key}] is missing.".light_red)
+            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.".light_red)
+          raise
+        end
+
+        fastly = ::Fastly.new({
+          :api_key => options[:api_key]
+        })
+
+        options[:base_urls].each do |base_url|
+          files.each do |file|
+            begin
+              url = "#{base_url}#{file}"
+              say_status("Invalidating #{url}... ", newline: false)
+              fastly.purge("#{base_url}#{file}")
+            rescue => e
+              say_status(", " + "error: #{e.message}".light_red, header: false)
+            else
+              say_status("✔".light_green, header: false)
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/middleman-cdn/commands.rb

@@ -3,6 +3,7 @@ require "middleman-cdn/extension"
 require "middleman-cdn/cdns/base.rb"
 require "middleman-cdn/cdns/cloudflare.rb"
 require "middleman-cdn/cdns/cloudfront.rb"
+require "middleman-cdn/cdns/fastly.rb"
 require "colorize"
 
 module Middleman
@@ -63,7 +64,8 @@ module Middleman
       def cdns
         [
           CloudFlareCDN,
-          CloudFrontCDN
+          CloudFrontCDN,
+          FastlyCDN
         ]
       end
 

data/lib/middleman-cdn/extension.rb

@@ -11,6 +11,7 @@ module Middleman
     class CDNExtension < Middleman::Extension
       option :cloudflare, nil, 'CloudFlare options'
       option :cloudfront, nil, 'CloudFront options'
+      option :fastly, nil, 'Fastly options'
       option :filter, nil, 'Cloudflare options'
       option :after_build, false, 'Cloudflare options'
 

data/lib/middleman-cdn/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module CDN
-    VERSION = '0.1.7'
+    VERSION = '0.1.8'
   end
 end

data/middleman-cdn.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'fog', '~> 1.9'
   s.add_dependency 'cloudflare', '~> 2.0'
+  s.add_dependency 'fastly', '~> 1.1'
   s.add_dependency 'colorize', '~> 0.7'
   s.add_dependency 'activesupport', '~> 4.1'
 

data/spec/lib/middleman-cdn/cdns/base_protocol.rb

@@ -30,8 +30,8 @@ shared_examples "BaseCDN" do
       expect(described_class.example_configuration).to eq(
       <<-TEXT
   cdn.#{described_class.key} = {
-    key1: "value"              # comment
-    key2: ["arr1", "arr2"]     #
+    key1: "value",             # comment
+    key2: ["arr1", "arr2"],    #
   }
 TEXT
       )

data/spec/lib/middleman-cdn/cdns/fastly_spec.rb

@@ -0,0 +1,196 @@
+#Encoding: UTF-8
+require 'spec_helper'
+require 'lib/middleman-cdn/cdns/base_protocol'
+
+describe Middleman::Cli::FastlyCDN do
+  it_behaves_like "BaseCDN"
+
+  describe '.key' do
+    it "should be 'fastly'" do
+      expect(described_class.key).to eq("fastly")
+    end
+  end
+
+  describe '.example_configuration_elements' do
+    it "should contain these keys" do
+      required_keys = [:api_key, :base_urls]
+      expect(described_class.example_configuration_elements.keys).to eq(required_keys)
+    end
+  end
+
+  describe '#invalidate' do
+    let(:double_fastly) { double("::Fastly") }
+
+    before do
+      allow(double_fastly).to receive(:purge)
+      allow(::Fastly).to receive(:new).and_return(double_fastly)
+    end
+
+    let(:files) { [ "/index.html", "/", "/test/index.html", "/test/image.png" ] }
+
+    context "all options provided" do
+      let(:options) do
+        {
+          api_key: '000000000000000000000',
+          base_urls: ['http://www.example.com', 'https://www.example.com']
+        }
+      end
+
+      it "should connect to fastly with credentails" do
+        expect(::Fastly).to receive(:new).with({:api_key => "000000000000000000000"})
+        subject.invalidate(options, files)
+      end
+
+      it "should not raise errors" do
+        subject.invalidate(options, files)
+      end
+
+      it "should call cloudflare to purge each file for each base url" do
+        expect(double_fastly).to receive(:purge).once.ordered.with("http://www.example.com/index.html")
+        expect(double_fastly).to receive(:purge).once.ordered.with("http://www.example.com/")
+        expect(double_fastly).to receive(:purge).once.ordered.with("http://www.example.com/test/index.html")
+        expect(double_fastly).to receive(:purge).once.ordered.with("http://www.example.com/test/image.png")
+        expect(double_fastly).to receive(:purge).once.ordered.with("https://www.example.com/index.html")
+        expect(double_fastly).to receive(:purge).once.ordered.with("https://www.example.com/")
+        expect(double_fastly).to receive(:purge).once.ordered.with("https://www.example.com/test/index.html")
+        expect(double_fastly).to receive(:purge).once.ordered.with("https://www.example.com/test/image.png")
+        subject.invalidate(options, files)
+      end
+
+      it "should output saying invalidating each file checkmarks" do
+        files_escaped = files.map { |file| Regexp.escape(file) }
+        expect { subject.invalidate(options, files) }.to output(/#{files_escaped.join(".+")}/m).to_stdout
+      end
+
+      it "should output indicating invalidating on all base urls" do
+        base_urls_escaped = options[:base_urls].map { |base_url| Regexp.escape(base_url) }
+        expect { subject.invalidate(options, files) }.to output(/#{base_urls_escaped.join(".+")}/m).to_stdout
+      end
+
+      it "should output saying success checkmarks" do
+        expect { subject.invalidate(options, files) }.to output(/✔/).to_stdout
+      end
+
+      context "and errors occurs when purging" do
+        before do
+          allow(double_fastly).to receive(:purge).and_raise(StandardError)
+        end
+
+        it "should output saying error information" do
+          expect { subject.invalidate(options, files) }.to output(/error: StandardError/).to_stdout
+        end
+      end
+    end
+
+    context "environment variables used for credentials" do
+      before do
+        allow(ENV).to receive(:[])
+        allow(ENV).to receive(:[]).with("FASTLY_API_KEY").and_return("111111111111111111111")
+      end
+
+      let(:options) do
+        {
+          base_urls: ['http://www.example.com', 'https://www.example.com']
+        }
+      end
+
+      it "should connect to fastly with environment variable credentails" do
+        expect(::Fastly).to receive(:new).with({:api_key => "111111111111111111111"})
+        subject.invalidate(options, files)
+      end
+
+      it "should not raise errors" do
+        subject.invalidate(options, files)
+      end
+    end
+
+    context "if client_api_key not provided" do
+      before do
+        allow(ENV).to receive(:[])
+        allow(ENV).to receive(:[]).with("FASTLY_API_KEY").and_return(nil)
+      end
+
+      let(:options) do
+        {
+          base_urls: ['http://www.example.com', 'https://www.example.com']
+        }
+      end
+
+      it "should raise error" do
+        expect { subject.invalidate(options, files) }.to raise_error(RuntimeError)
+      end
+
+      it "should output saying error" do
+        expect { subject.invalidate(options, files) rescue nil }.to output(/Error: Configuration key fastly\[:api_key\] is missing\./).to_stdout
+      end
+    end
+
+    context "if base_urls not provided" do
+      let(:options) do
+        {
+          api_key: '000000000000000000000'
+        }
+      end
+
+      it "should raise error" do
+        expect { subject.invalidate(options, files) }.to raise_error(RuntimeError)
+      end
+
+      it "should output saying error" do
+        expect { subject.invalidate(options, files) rescue nil }.to output(/Error: Configuration key fastly\[:base_urls\] is missing\./).to_stdout
+      end
+    end
+
+    context "if base_urls is a String" do
+      let(:options) do
+        {
+          api_key: '000000000000000000000',
+          base_urls: 'http://sub.example.com'
+        }
+      end
+
+      it "should not raise error" do
+        expect { subject.invalidate(options, files) }.to_not raise_error
+      end
+
+      it "should output indicating invalidating on the one base url" do
+        base_url_escaped = Regexp.escape(options[:base_urls])
+        expect { subject.invalidate(options, files) }.to output(/#{base_url_escaped}/).to_stdout
+      end
+    end
+
+    context "if base_urls is an empty Array" do
+      let(:options) do
+        {
+          api_key: '000000000000000000000',
+          base_urls: []
+        }
+      end
+
+      it "should raise error" do
+        expect { subject.invalidate(options, files) }.to raise_error(RuntimeError)
+      end
+
+      it "should output saying error" do
+        expect { subject.invalidate(options, files) rescue nil }.to output(/Error: Configuration key fastly\[:base_urls\] is missing\./).to_stdout
+      end
+    end
+
+    context "if base_urls is not an Array or String" do
+      let(:options) do
+        {
+          api_key: '000000000000000000000',
+          base_urls: 200
+        }
+      end
+
+      it "should raise error" do
+        expect { subject.invalidate(options, files) }.to raise_error(RuntimeError)
+      end
+
+      it "should output saying error" do
+        expect { subject.invalidate(options, files) rescue nil }.to output(/Error: Configuration key fastly\[:base_urls\] must be an array and contain at least one base url\./).to_stdout
+      end
+    end
+  end
+end

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

@@ -37,6 +37,7 @@ describe Middleman::Cli::CDN do
         it "should invalidate the files with only cloudflare" do
           expect_any_instance_of(::Middleman::Cli::CloudFlareCDN).to_not receive(:invalidate)
           expect_any_instance_of(::Middleman::Cli::CloudFrontCDN).to_not receive(:invalidate)
+          expect_any_instance_of(::Middleman::Cli::FastlyCDN).to_not receive(:invalidate)
           expect { subject.cdn_invalidate(options) }.to raise_error(RuntimeError)
         end
       end
@@ -52,6 +53,7 @@ describe Middleman::Cli::CDN do
         it "should invalidate the files with only cloudflare" do
           expect_any_instance_of(::Middleman::Cli::CloudFlareCDN).to receive(:invalidate).with(options.cloudflare, ["/index.html", "/image.png", "/"])
           expect_any_instance_of(::Middleman::Cli::CloudFrontCDN).to_not receive(:invalidate)
+          expect_any_instance_of(::Middleman::Cli::FastlyCDN).to_not receive(:invalidate)
           subject.cdn_invalidate(options)
         end
       end
@@ -61,6 +63,7 @@ describe Middleman::Cli::CDN do
           OpenStruct.new({
             cloudflare: {},
             cloudfront: {},
+            fastly: {},
             filter: /.*/
           })
         end
@@ -68,6 +71,7 @@ describe Middleman::Cli::CDN do
         it "should invalidate the files with all cdns" do
           expect_any_instance_of(::Middleman::Cli::CloudFlareCDN).to receive(:invalidate).with(options.cloudflare, ["/index.html", "/image.png", "/"])
           expect_any_instance_of(::Middleman::Cli::CloudFrontCDN).to receive(:invalidate).with(options.cloudfront, ["/index.html", "/image.png", "/"])
+          expect_any_instance_of(::Middleman::Cli::FastlyCDN).to receive(:invalidate).with(options.fastly, ["/index.html", "/image.png", "/"])
           subject.cdn_invalidate(options)
         end
       end
@@ -78,6 +82,7 @@ describe Middleman::Cli::CDN do
         OpenStruct.new({
           cloudflare: {},
           cloudfront: {},
+          fastly: {},
           filter: /\.html/
         })
       end
@@ -85,6 +90,7 @@ describe Middleman::Cli::CDN do
       it "should invalidate the files with all cdns" do
         expect_any_instance_of(::Middleman::Cli::CloudFlareCDN).to receive(:invalidate).with(options.cloudflare, ["/index.html", "/"])
         expect_any_instance_of(::Middleman::Cli::CloudFrontCDN).to receive(:invalidate).with(options.cloudfront, ["/index.html", "/"])
+        expect_any_instance_of(::Middleman::Cli::FastlyCDN).to receive(:invalidate).with(options.cloudfront, ["/index.html", "/"])
         subject.cdn_invalidate(options)
       end
     end
@@ -94,6 +100,7 @@ describe Middleman::Cli::CDN do
         OpenStruct.new({
           cloudflare: {},
           cloudfront: {},
+          fastly: {},
           filter: /\.htm$/
         })
       end
@@ -101,6 +108,7 @@ describe Middleman::Cli::CDN do
       it "should invalidate the files with all cdns" do
         expect_any_instance_of(::Middleman::Cli::CloudFlareCDN).to_not receive(:invalidate)
         expect_any_instance_of(::Middleman::Cli::CloudFrontCDN).to_not receive(:invalidate)
+        expect_any_instance_of(::Middleman::Cli::FastlyCDN).to_not receive(:invalidate)
         subject.cdn_invalidate(options)
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-cdn
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Leigh McCulloch
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fastly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +139,7 @@ files:
 - lib/middleman-cdn/cdns/base.rb
 - lib/middleman-cdn/cdns/cloudflare.rb
 - lib/middleman-cdn/cdns/cloudfront.rb
+- lib/middleman-cdn/cdns/fastly.rb
 - lib/middleman-cdn/commands.rb
 - lib/middleman-cdn/extension.rb
 - lib/middleman-cdn/version.rb
@@ -133,6 +148,7 @@ files:
 - spec/lib/middleman-cdn/cdns/base_protocol.rb
 - spec/lib/middleman-cdn/cdns/cloudflare_spec.rb
 - spec/lib/middleman-cdn/cdns/cloudfront_spec.rb
+- spec/lib/middleman-cdn/cdns/fastly_spec.rb
 - spec/lib/middleman-cdn/commands_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/leighmcculloch/middleman-cdn