middleman-cdn 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0db2d194f1dd93aea915bd2a954c977f24678d4
-  data.tar.gz: c59dc210e2d7a273e5255a85376d283496b0d6d5
+  metadata.gz: f2489e5e48befb67ac4262785c5d50eafc4f38bc
+  data.tar.gz: 06de2636504f543675da89ffccf1f9e8b364704b
 SHA512:
-  metadata.gz: a4f961344e60c4297417cc6152b0673387d44c786f8b505c5b0a4c68d44523a2dcb0fa2ffc184e2c29574c14c3d7bf2189d1abd5048512396edddacf3cb049c1
-  data.tar.gz: e586736630bf84c1d6eccd1eb997671f6cfc162f2f26f034952346cf1bb66e0b6ddae7a962461b799430d3af174cbabed46f18594b5894550d6d9b9d55bfc96d
+  metadata.gz: 04ceb24a4ed31df414973cf66396c8add45475c27984ae9e80b8ebc51df7718e9f24183f263cd87c7510d980461f281a6da2161ec55ada2f1eb9ef94c3ea675b
+  data.tar.gz: b65fa9621dcfcece07031d290b8a4a1794026c9123da238da053a47237ed69b1c9c0f7e797d432f285166a495812643ef7e08695115319d559618202beca269b

data/README.md

@@ -1,6 +1,5 @@
-# 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.
+# Middleman CDN
+[![Gem Version](https://badge.fury.io/rb/middleman-cdn.svg)](http://badge.fury.io/rb/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 [middleman](http://middlemanapp.com/) deploy tool for invalidating resources cached
 on common Content Delivery Networks (CDNs).
@@ -8,14 +7,14 @@ on common Content Delivery Networks (CDNs).
 * Cache invalidation of files on:
   * [CloudFlare](https://cloudflare.com)
   * [Fastly](https://fastly.com)
-  * [Amazon CloudFront](http://aws.amazon.com/cloudfront/)
+  * [MaxCDN](https://maxcdn.com)
+  * [Amazon CloudFront](https://aws.amazon.com/cloudfront/)
 * Select files for invalidation with regex.  
 * Automatically invalidate after build.
 * Manually trigger invalidation with single command.
 
 What's next?
 
-* Add support for MaxCDN.
 * Add support for RackspaceCDN (Akamai).
 * [Open an issue](../../issues/new) if you'd like your CDN provider added.
 
@@ -54,6 +53,12 @@ activate :cdn do |cdn|
       'https://www.example.com'
     ],
   }
+  cdn.maxcdn = {
+    alias: "...",                   # default ENV['MAXCDN_ALIAS']
+    consumer_key: "...",            # default ENV['MAXCDN_CONSUMER_KEY']
+    consumer_secret: "...",         # default ENV['MAXCDN_CONSUMER_SECRET']
+    zone_id: "...",
+  }
   cdn.cloudfront = {
     access_key_id: '...',           # default ENV['AWS_ACCESS_KEY_ID']
     secret_access_key: '...',       # default ENV['AWS_SECRET_ACCESS_KEY']
@@ -116,6 +121,23 @@ at.
 
 Fastly invalidations often take a few seconds.
 
+### Configuration: MaxCDN
+
+The `maxcdn` parameter contains the information specific to your MaxCDN
+account. You'll need to create an `application` in your MaxCDN account which
+will provide you with API keys, and your alias can be found on the API tab of
+your account page. The extension works by invalidating files in pull zones.
+Make sure you add your website as a pull zone.
+
+| Parameter | Description |
+|:--------- |:----------- |
+| `alias` | You can find this by logging into MaxCDN, going to your account page, and then going to the API tab and it will be down the bottom right. |
+| `consumer_key` | You can find this by logging into MaxCDN, going to your account page, and then going to the API tab and creating an application which will give you a key and secret. |
+| `secret_key` | You can find this by logging into MaxCDN, going to your account page, and then going to the API tab and creating an application which will give you a key and secret. |
+| `zone_id` | Each pull zone has a zone_id, you'll find this in your account. |
+
+MaxCDN invalidations often take a few seconds.
+
 ### Configuration: CloudFront
 
 The `cloudfront` parameter contains the information specific to your AWS CloudFront

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

@@ -0,0 +1,48 @@
+#Encoding: UTF-8
+require "maxcdn"
+require "active_support/core_ext/string"
+
+module Middleman
+  module Cli
+
+    class MaxCDN < BaseCDN
+      def self.key
+        "maxcdn"
+      end
+
+      def self.example_configuration_elements
+        {
+          alias: ['"..."', "# default ENV['MAXCDN_ALIAS']"],
+          consumer_key: ['"..."', "# default ENV['MAXCDN_CONSUMER_KEY']"],
+          consumer_secret: ['"..."', "# default ENV['MAXCDN_CONSUMER_SECRET']"],
+          zone_id: ['"..."', ""]
+        }
+      end
+
+      def invalidate(options, files)
+        options[:alias] ||= ENV['MAXCDN_ALIAS']
+        options[:consumer_key] ||= ENV['MAXCDN_CONSUMER_KEY']
+        options[:consumer_secret] ||= ENV['MAXCDN_CONSUMER_SECRET']
+
+        [:alias, :consumer_key, :consumer_secret, :zone_id].each do |key|
+          if options[key].blank?
+            say_status("Error: Configuration key maxcdn[:#{key}] is missing.".light_red)
+            raise
+          end
+        end
+
+        maxcdn = ::MaxCDN::Client.new(options[:alias], options[:consumer_key], options[:consumer_secret])
+
+        begin
+          say_status("Invalidating #{files.count} files...", newline: false)
+          maxcdn.purge(options[:zone_id], files)
+        rescue => e
+          say_status(", " + "error: #{e.message}".light_red, header: false)
+        else
+          say_status("✔".light_green, header: false)
+        end
+      end
+    end
+
+  end
+end

data/lib/middleman-cdn/commands.rb

@@ -4,6 +4,7 @@ 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 "middleman-cdn/cdns/maxcdn.rb"
 require "colorize"
 
 module Middleman
@@ -39,6 +40,7 @@ module Middleman
 
         files = list_files(options.filter)
         self.class.say_status(nil, "Invalidating #{files.count} files with filter: " + "#{options.filter.source}".magenta.bold)
+        files.each { |file| self.class.say_status(nil, " • #{file}") }
         return if files.empty?
 
         cdns_keyed.each do |cdn_key, cdn|
@@ -65,7 +67,8 @@ module Middleman
         [
           CloudFlareCDN,
           CloudFrontCDN,
-          FastlyCDN
+          FastlyCDN,
+          MaxCDN
         ]
       end
 

data/lib/middleman-cdn/extension.rb

@@ -12,6 +12,7 @@ module Middleman
       option :cloudflare, nil, 'CloudFlare options'
       option :cloudfront, nil, 'CloudFront options'
       option :fastly, nil, 'Fastly options'
+      option :maxcdn, nil, 'MaxCDN 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.8'
+    VERSION = '0.1.9'
   end
 end

data/middleman-cdn.gemspec

@@ -20,6 +20,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 'maxcdn', '~> 0.1'
   s.add_dependency 'colorize', '~> 0.7'
   s.add_dependency 'activesupport', '~> 4.1'
 

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

@@ -0,0 +1,185 @@
+#Encoding: UTF-8
+require 'spec_helper'
+require 'lib/middleman-cdn/cdns/base_protocol'
+
+describe Middleman::Cli::MaxCDN do
+  it_behaves_like "BaseCDN"
+
+  describe '.key' do
+    it "should be 'maxcdn'" do
+      expect(described_class.key).to eq("maxcdn")
+    end
+  end
+
+  describe '.example_configuration_elements' do
+    it "should contain these keys" do
+      required_keys = [:alias, :consumer_key, :consumer_secret, :zone_id]
+      expect(described_class.example_configuration_elements.keys).to eq(required_keys)
+    end
+  end
+
+  describe '#invalidate' do
+    let(:double_maxcdn) { double("::MaxCDN::Client") }
+
+    before do
+      allow(double_maxcdn).to receive(:purge)
+      allow(::MaxCDN::Client).to receive(:new).and_return(double_maxcdn)
+    end
+
+    let(:files) { [ "/index.html", "/", "/test/index.html", "/test/image.png" ] }
+
+    context "all options provided" do
+      let(:options) do
+        {
+          alias: "00000000000000000000",
+          consumer_key: "11111111111111111111",
+          consumer_secret: "22222222222222222222",
+          zone_id: "33333333",
+        }
+      end
+
+      it "should connect to maxcdn with credentails" do
+        expect(::MaxCDN::Client).to receive(:new).with("00000000000000000000", "11111111111111111111", "22222222222222222222")
+        subject.invalidate(options, files)
+      end
+
+      it "should not raise errors" do
+        subject.invalidate(options, files)
+      end
+
+      it "should call cloudflare to purge all files in one hit" do
+        expect(double_maxcdn).to receive(:purge).with("33333333", ["/index.html", "/", "/test/index.html", "/test/image.png"])
+        subject.invalidate(options, files)
+      end
+
+      it "should output saying invalidating each file" do
+        expect { subject.invalidate(options, files) }.to output(/Invalidating 4 files.../).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_maxcdn).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("MAXCDN_ALIAS").and_return("00000000000000000000")
+        allow(ENV).to receive(:[]).with("MAXCDN_CONSUMER_KEY").and_return("11111111111111111111")
+        allow(ENV).to receive(:[]).with("MAXCDN_CONSUMER_SECRET").and_return("22222222222222222222")
+      end
+
+      let(:options) do
+        {
+          zone_id: "33333333",
+        }
+      end
+
+      it "should connect to maxcdn with environment variable credentails" do
+        expect(::MaxCDN::Client).to receive(:new).with("00000000000000000000", "11111111111111111111", "22222222222222222222")
+        subject.invalidate(options, files)
+      end
+
+      it "should not raise errors" do
+        subject.invalidate(options, files)
+      end
+    end
+
+    context "if alias not provided" do
+      before do
+        allow(ENV).to receive(:[])
+        allow(ENV).to receive(:[]).with("MAXCDN_ALIAS").and_return(nil)
+      end
+
+      let(:options) do
+        {
+          consumer_key: "11111111111111111111",
+          consumer_secret: "22222222222222222222",
+          zone_id: "33333333",
+        }
+      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 maxcdn\[:alias\] is missing\./).to_stdout
+      end
+    end
+
+    context "if consumer_key not provided" do
+      before do
+        allow(ENV).to receive(:[])
+        allow(ENV).to receive(:[]).with("MAXCDN_CONSUMER_KEY").and_return(nil)
+      end
+
+      let(:options) do
+        {
+          alias: "00000000000000000000",
+          consumer_secret: "22222222222222222222",
+          zone_id: "33333333",
+        }
+      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 maxcdn\[:consumer_key\] is missing\./).to_stdout
+      end
+    end
+
+    context "if consumer_secret not provided" do
+      before do
+        allow(ENV).to receive(:[])
+        allow(ENV).to receive(:[]).with("MAXCDN_CONSUMER_SECRET").and_return(nil)
+      end
+
+      let(:options) do
+        {
+          alias: "00000000000000000000",
+          consumer_key: "11111111111111111111",
+          zone_id: "33333333",
+        }
+      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 maxcdn\[:consumer_secret\] is missing\./).to_stdout
+      end
+    end
+
+    context "if zone_id not provided" do
+      let(:options) do
+        {
+          alias: "00000000000000000000",
+          consumer_key: "11111111111111111111",
+          consumer_secret: "22222222222222222222",
+        }
+      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 maxcdn\[:zone_id\] is missing\./).to_stdout
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-cdn
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Leigh McCulloch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: maxcdn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +154,7 @@ files:
 - lib/middleman-cdn/cdns/cloudflare.rb
 - lib/middleman-cdn/cdns/cloudfront.rb
 - lib/middleman-cdn/cdns/fastly.rb
+- lib/middleman-cdn/cdns/maxcdn.rb
 - lib/middleman-cdn/commands.rb
 - lib/middleman-cdn/extension.rb
 - lib/middleman-cdn/version.rb
@@ -149,6 +164,7 @@ files:
 - 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/cdns/maxcdn_spec.rb
 - spec/lib/middleman-cdn/commands_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/leighmcculloch/middleman-cdn