middleman-keycdn 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6f2697cd177060013668ec2337024217372440c
+  data.tar.gz: d99041e88c39da3264e993975f15e32845690916
+SHA512:
+  metadata.gz: 33b4558ede706d4f47565533c946426b877d1d7f5df0f83e9dc8cca893833f60017f83f90191add988d8146336c86ffd8fd7ecab8718c1aaa0189b42d75a96cd
+  data.tar.gz: 30b575e433fec23bb8e135a70b0fcfd9bec3176b8e5569fb54d180ca208f964a9ac555328c57eabf62440c52dbfd7f0bc5e66d6fb441385b45f37c67073d26bc

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+coverage
+.ruby-version
+*.sublime-*
+*.gem
+pkg

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+cache: bundler
+before_script:
+  - gem update --system
+  - gem update bundler
+rvm:
+  - 2.2.5
+  - 2.3.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rspec', cli: '--drb --profile', all_after_pass: false do
+  # Specs
+  watch(%r(^spec/.+_spec\.rb$))
+  watch('spec/spec_helper.rb')       { 'spec' }
+  watch(%r(^spec/support/(.+)\.rb$)) { 'spec' }
+
+  # Files
+  watch(%r(^lib/(.+)\.rb$))          { |m| "spec/lib/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Andrey Korzhuev <andrew@korzhuev.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Middleman KeyCDN [![Build Status](https://travis-ci.org/ideasasylum/middleman-keycdn.svg?branch=master)](https://travis-ci.org/ideasasylum/middleman-keycdn) [![Dependency Status](https://gemnasium.com/ideasasylum/middleman-keycdn.png)](https://gemnasium.com/ideasasylum/middleman-keycdn) [![Code Climate](https://codeclimate.com/github/ideasasylum/middleman-keycdn.png)](https://codeclimate.com/github/ideasasylum/middleman-keycdn)
+
+A deploying tool for middleman which invalidates a [KeyCDN](https://www.keycdn.com/?a=25888) cache.
+
+Based almost entirely on [middleman-cloudfront](https://github.com/andrusha/middleman-cloudfront) and used together with [middleman-s3_sync](https://github.com/fredjean/middleman-s3_sync) (though you can use whatever deployment method & KeyCDN source you want)
+
+Some of its features are:  
+
+* KeyCDN cache invalidation — either purge the whole cache or just updated selected URLs;
+* Ability to call it from command line and after middleman build;  
+* Ability to filter files which are going to be invalidated by regex;  
+
+# Usage
+
+## Installation
+
+Add this to `Gemfile`:  
+```ruby
+gem 'middleman-keycdn'
+```
+
+Then run:
+```
+bundle install
+```
+
+## Configuration
+
+Edit `config.rb` and add:  
+
+```ruby
+activate :keycdn do |cdn|
+  cdn.api_key = ENV['KEYCDN_API_KEY']
+  cdn.zone_id = ENV['KEYCDN_ZONE_ID']
+  cdn.base_url = ENV['KEYCDN_BASE_URL']
+  cdn.purge_all = true
+  cdn.filter = /.html$/i  # default is /.*/
+  cdn.after_build = true  # default is false
+end```
+
+## Running
+
+If you set `after_build` to `true` cache would be automatically invalidated after build:  
+```bash
+bundle exec middleman build
+```
+
+Otherwise you should run it through commandline interface like so:  
+```bash
+bundle exec middleman invalidate
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/middleman-keycdn.rb

@@ -0,0 +1,4 @@
+require 'pathname' # for some reason, had to require this because middleman-core 4.1.7 did not.
+require 'middleman-keycdn/extension'
+
+Middleman::Extensions.register :keycdn, Middleman::KeyCDN::Extension

data/lib/middleman-keycdn/commands/invalidate.rb

@@ -0,0 +1,152 @@
+require 'middleman-cli'
+require 'middleman-keycdn/extension'
+require 'keycdn'
+require 'ansi/code'
+
+module Middleman
+  module Cli
+    module KeyCDN
+      # This class provides an "invalidate" command for the middleman CLI.
+      class Invalidate < ::Thor::Group
+        include Thor::Actions
+
+        INVALIDATION_LIMIT = 1000
+        INDEX_REGEX = /
+          \A
+            (.*\/)?
+            index\.html
+          \z
+        /ix
+
+        check_unknown_options!
+
+        def self.exit_on_failure?
+          true
+        end
+
+        def invalidate(opts = nil, files = nil)
+          @options = setup_options opts
+
+          ensure_required_options_present
+
+          if @options.purge_all
+            purge_all
+          else
+            purge_urls files
+          end
+        end
+
+        protected
+
+        def setup_options opts
+          # If called via commandline, discover config (from bin/middleman)
+          if opts.nil?
+            app = Middleman::Application.new do
+              config[:mode] = :config
+              config[:exit_before_ready] = true
+              config[:watcher_disable] = true
+              config[:disable_sitemap] = true
+            end
+
+            # Get the opts from the keycdn extension
+            extension = app.extensions[:keycdn]
+            unless extension.nil?
+              opts = extension.options
+            end
+          end
+
+          if opts.nil?
+            configuration_usage
+          end
+
+          opts
+        end
+
+        def ensure_required_options_present
+          [:api_key, :zone_id, :base_url].each do |key|
+            raise StandardError, "Configuration key #{key} is missing." if @options.public_send(key).nil?
+          end
+
+          if !@options.purge_all
+            [:base_url, :filter].each do |key|
+              raise StandardError, "Configuration key #{key} is missing." if @options.public_send(key).nil?
+            end
+          end
+        end
+
+        def purge_all
+          puts "Invalidating KeyCDN cache for #{@options.zone_id}"
+          response = cdn.get("zones/purge/#{@options.zone_id}.json")
+          print_status response
+        end
+
+        def purge_urls files
+          files = normalize_files(files || list_files(@options.filter))
+          return if files.empty?
+          urls = files.collect.with_index { |file, index| ["urls[#{index}]", "#{@options.base_url}#{file}"] }
+          puts "Invalidating #{files.count} urls."
+          # puts urls.inspect
+          response = cdn.del("zones/purgeurl/#{@options.zone_id}.json", Hash[urls])
+          print_status response
+        end
+
+        def print_status response
+          if response['status'] == 'success'
+            puts ANSI.green { "#{response['description']}" }
+          else
+            puts ANSI.red { "#{response['description']}" }
+          end
+        end
+
+        def cdn
+          ::KeyCDN::Client.new @options.api_key
+        end
+
+        def configuration_usage
+          raise StandardError, <<-TEXT
+ERROR: You need to activate the keycdn extension in config.rb.
+
+The example configuration is:
+activate :keycdn do |cf|
+  cf.api_key = ENV['KEYCDN_API_KEY']
+  cf.zone_id = ENV['KEYCDN_ZONE_ID']
+  cf.base_url = ENV['KEYCDN_BASE_URL']
+  cf.purge_all = false
+  cf.filter = /.html$/i  # default is /.*/
+  cf.after_build = true  # default is false
+end
+          TEXT
+        end
+
+        def list_files(filter)
+          Dir.chdir('build/') do
+            Dir.glob('**/*', File::FNM_DOTMATCH).tap do |files|
+              # Remove directories
+              files.reject! { |f| File.directory?(f) }
+
+              # Remove files that do not match filter
+              files.reject! { |f| f !~ filter }
+            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_REGEX).map do |file|
+            file == 'index.html' ? '/' : File.dirname(file) << '/'
+          end.uniq
+
+          # URI encode and add leading slash
+          files.map { |f| URI::encode(f.start_with?('/') ? f : "/#{f}") }
+        end
+
+        # Add to CLI
+        Base.register(self, 'invalidate', 'invalidate', 'Invalidate a KeyCDN zone.')
+
+        # Map "inv" to "invalidate"
+        Base.map('inv' => 'invalidate')
+      end
+    end
+  end
+end

data/lib/middleman-keycdn/extension.rb

@@ -0,0 +1,32 @@
+require 'middleman-core'
+require 'middleman-keycdn/commands/invalidate'
+
+module Middleman
+  module KeyCDN
+    class Extension < Middleman::Extension
+      # @param [Symbol] key The name of the option
+      # @param [Object] default The default value for the option
+      # @param [String] description A human-readable description of what the option does
+      option :api_key, nil, 'API key'
+      option :zone_id, nil, 'Zone id'
+      option :base_url, nil, 'The base url for the site (only required when purging individual urls'
+      option :purge_all, true, 'Purge the whole cache (true) or individual urls (false)'
+      option :filter, /.*/, 'Filter files to be invalidated'
+      option :after_build, false, 'Invalidate after build'
+
+      def initialize(app, options_hash={}, &block)
+        super
+      end
+
+      def after_build
+        Middleman::Cli::KeyCDN::Invalidate.new.invalidate(options) if options.after_build
+      end
+
+      helpers do
+        def invalidate(files = nil)
+          Middleman::Cli::KeyCDN::Invalidate.new.invalidate(options, files)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-keycdn/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module KeyCDN
+    VERSION = '0.1'
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-keycdn'

data/middleman-keycdn.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'middleman-keycdn/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-keycdn'
+  s.version     = Middleman::KeyCDN::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jamie Lawrence"]
+  s.email       = ["jamie@ideasasylum.com"]
+  s.homepage    = "https://github.com/ideasasylum/middleman-keycdn"
+  s.summary     = %q{Invalidate KeyCDN cache after deployment to S3}
+  s.description = %q{Adds ability to invalidate a specific set of files in your KeyCDN cache}
+
+  s.files         = `git ls-files -z`.split("\0")
+  s.test_files    = `git ls-files -z -- {fixtures,features}/*`.split("\0")
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_development_dependency 'rake', '>= 0.9.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+
+  s.add_dependency 'middleman-core', '~> 4.0'
+  s.add_dependency 'middleman-cli', '~> 4.0'
+  s.add_dependency 'keycdn', '~> 0.1.1'
+  s.add_dependency 'ansi', '~> 1.5'
+end

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

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Middleman::Cli::KeyCDN::Invalidate do
+
+  let(:cdn) { described_class.new }
+  let(:zone) { 'zone123' }
+  let(:base_url) { 'example.com' }
+  let(:options) do
+    config = Middleman::Configuration::ConfigurationManager.new
+    config.api_key = 'api123'
+    config.zone_id = zone
+    config.base_url = base_url
+    config.purge_all = true
+    config.filter = /.html$/i  # default is /.*/
+    config.after_build = true  # default is false
+    config
+  end
+  let(:success) do { status: 'success', description: 'ok' } end
+  let(:purge_all_cmd) { "zones/purge/#{zone}.json" }
+  let(:purge_urls_cmd) { "zones/purgeurl/#{zone}.json" }
+
+  context 'purge all' do
+    it 'purge the zone' do
+      allow(cdn).to receive(:list_files).and_return([])
+      expect_any_instance_of(KeyCDN::Client).to receive(:get).with(purge_all_cmd).and_return(success)
+      cdn.invalidate(options)
+    end
+  end
+
+  context 'purge urls' do
+    before(:each) { options.purge_all = false }
+    it 'normalizes paths' do
+      files = %w(file directory/index.html)
+      normalized_files = %w(/file /directory/index.html /directory/)
+      allow(cdn).to receive(:list_files).and_return(files)
+      urls = {
+        'urls[0]' => 'example.com/file',
+        'urls[1]' => 'example.com/directory/index.html',
+        'urls[2]' => 'example.com/directory/',
+      }
+      expect_any_instance_of(KeyCDN::Client).to receive(:del).with(purge_urls_cmd, urls).and_return(success)
+      cdn.invalidate(options)
+    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}" }
+        urls = {
+          'urls[0]' => 'example.com/file_1',
+          'urls[1]' => 'example.com/file_2',
+          'urls[2]' => 'example.com/file_3',
+        }
+        expect_any_instance_of(KeyCDN::Client).to receive(:del).with(purge_urls_cmd, urls).and_return(success)
+        cdn.invalidate(options, files)
+      end
+
+      it "doesn't filter them" do
+        files = (1..3).map { |i| "/file_#{i}" }
+        options.filter = /filter that matches no files/
+        urls = {
+          'urls[0]' => 'example.com/file_1',
+          'urls[1]' => 'example.com/file_2',
+          'urls[2]' => 'example.com/file_3',
+        }
+        expect_any_instance_of(KeyCDN::Client).to receive(:del).with(purge_urls_cmd, urls).and_return(success)
+        cdn.invalidate(options, files)
+      end
+
+      it 'normalizes them' do
+        files = %w(file directory/index.html)
+        normalized_files = %w(/file /directory/index.html /directory/)
+        urls = {
+          'urls[0]' => 'example.com/file',
+          'urls[1]' => 'example.com/directory/index.html',
+          'urls[2]' => 'example.com/directory/',
+        }
+        expect_any_instance_of(KeyCDN::Client).to receive(:del).with(purge_urls_cmd, urls).and_return(success)
+        cdn.invalidate(options, files)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'middleman-keycdn'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: middleman-keycdn
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jamie Lawrence
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-01 00:00:00.000000000 Z
+dependencies:
+- !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: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: middleman-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: keycdn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Adds ability to invalidate a specific set of files in your KeyCDN cache
+email:
+- jamie@ideasasylum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-keycdn.rb
+- lib/middleman-keycdn/commands/invalidate.rb
+- lib/middleman-keycdn/extension.rb
+- lib/middleman-keycdn/version.rb
+- lib/middleman_extension.rb
+- middleman-keycdn.gemspec
+- spec/lib/middleman-cloudfront/invalidate_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ideasasylum/middleman-keycdn
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Invalidate KeyCDN cache after deployment to S3
+test_files: []