branchable_cdn_assets 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 644f8e575d2fbc7650f897c402e2614fe61a0d51
-  data.tar.gz: 23e3608e0f7aff7e39f22716b8332bc960e65bba
+  metadata.gz: 49f567d337137eb1f553b71d39026a2e0db533c4
+  data.tar.gz: a83f8ddb7c0346a5a0f2df8c63b863af7ee8f470
 SHA512:
-  metadata.gz: 8721d9341ceecc5c3067d32cb6944a1b4fc710acb6026281ecd1b630786755a0382638da9ec753723ec591966db119cd7e7ddd2ae9748d5f1fae7a333c61ad20
-  data.tar.gz: 04dcf0e047124ef84689627cbf46b0e4b493278ec5fb412f18c1aaee6b26bf9da2447bcd70f4464bf79e43b1e4d039ec0e0244d806912c4abcdb4f6dcdcf38ff
+  metadata.gz: 037301f07920418a121d73155478f9e5a3418647e49d7cdd3610103f8553f5cbf7f8be9c4e39b20c12dffde15f51983319bf7a44fc2a4bca45db9b39e80d3d10
+  data.tar.gz: 1b96408f5465c10d4bada8e114f2f3d955ebebb96b21a0b80cf2a30254209c83043241bdb621afa4c52b1f28fbc94c5fa6a2c95b1895ba058c7ca2ae3392eab8

data/lib/branchable_cdn_assets.rb

@@ -14,7 +14,7 @@ require_relative 'branchable_cdn_assets/shell'
 require_relative 'branchable_cdn_assets/file_manager'
 require_relative 'branchable_cdn_assets/manifest'
 require_relative 'branchable_cdn_assets/config'
-require_relative 'branchable_cdn_assets/cloudfront'
+require_relative 'branchable_cdn_assets/invalidator'
 
 module BranchableCDNAssets
 end

data/lib/branchable_cdn_assets/config.rb

@@ -6,20 +6,25 @@ module BranchableCDNAssets
     extend  EnvironmentAttributeReader::ClassMethods
 
     attr_reader :raw_data, :branch,
-                :production_branch, :cloudfront, :cdn_dir,
+                :production_branch, :cdn_dir, :file_filter,
                 :dir_permissions, :file_permissions, :rsync_flags
-    env_attr_reader :host, :root, :url, :manage_cloudfront
+    env_attr_reader :host, :root, :url
 
     def initialize data, branch=Asgit.current_branch
       @raw_data = normalize_data data
       @branch   = branch
 
       @production_branch = raw_data.fetch :production_branch, 'master'
-      @cloudfront        = raw_data.fetch :cloudfront,        {}
       @cdn_dir           = raw_data.fetch :dir,               'cdn'
+      @file_filter       = raw_data.fetch :file_filter,       nil
       @dir_permissions   = env_attr(:dir_permissions)      || 755
       @file_permissions  = env_attr(:file_permissions)     || 644
       @rsync_flags       = env_attr(:rsync_flags)          || '-aviz'
+      @allow_local       = env_attr(:allow_local)          || false
+
+      if @file_filter && ( !@file_filter.respond_to?(:arity) || @file_filter.arity != 1 )
+        raise ArgumentError, "file_filter must be a lambda accepting one argument"
+      end
     end
 
     def env
@@ -42,6 +47,21 @@ module BranchableCDNAssets
       end
     end
 
+    def invalidator
+      return @_invalidator if @_invalidator
+
+      invalidator_data = env_attr(:invalidator)
+      return false unless invalidator_data
+
+      invalidator_class = Invalidator.find(invalidator_data.keys.first)
+      if invalidator_class
+        @_invalidator = invalidator_class.new invalidator_data.values.first
+        return @_invalidator
+      else
+        raise ArgumentError, "no invalidators registered for key :#{invalidator_data.keys.first}"
+      end
+    end
+
     private
 
       class Remote < Struct.new(:host, :root, :url,
@@ -113,4 +133,4 @@ module BranchableCDNAssets
       end
 
   end
-end
+end

data/lib/branchable_cdn_assets/file_manager.rb

@@ -10,10 +10,8 @@ module BranchableCDNAssets
     check_before :local_file_conflict,            methods: [ :push!, :pull! ]
     check_before :ready_for_production,           methods: [ :move_to_production ]
 
-    attr_reader :config
-    attr_reader :root
-    attr_reader :branch
-    attr_reader :manifest
+    attr_reader :config, :manifest,
+                :root, :branch
 
     # handles moving files to/from our various cdn locations
     def initialize config, branch=nil
@@ -62,7 +60,7 @@ module BranchableCDNAssets
       setup_remotes
 
       push_list = push
-      if config.env.to_sym == :production && config.manage_cloudfront
+      if config.env.to_sym == :production
         invalidate( push_list )
       end
 
@@ -108,11 +106,14 @@ module BranchableCDNAssets
     end
 
 
-    def find file
-      return :local                      if list(:local).include?(file)
-      return File.join(config.url, file) if list(:remote).include?(file)
+    def find file, location=:all
+      if [:all, :local].include?(location) && list(:local).include?(file)
+        return :local
+      elsif [:all, :remote].include?(location) && list(:remote).include?(file)
+        return File.join(config.url, file)
+      end
 
-      unless config.env == :production
+      if config.env != :production && location != :local
         production_config   = Config.new( config.raw_data, config.production_branch )
         production_manifest = Manifest.new( File.join( root, "#{config.production_branch}.manifest" ) )
 
@@ -222,12 +223,17 @@ module BranchableCDNAssets
       end
 
       def invalidate files
-        to_invalidate = ( files & list(:local) ).map do |f|
-          File.join( config.cloudfront[:path_prefix], f )
-        end
+        if config.invalidator
+          to_invalidate = ( files & list(:local) ).map do |f|
+            if config.invalidator.config.respond_to? :path_prefix
+              File.join( config.invalidator.config.path_prefix, f )
+            else
+              f
+            end
+          end
 
-        Cloudfront.new( config.cloudfront )
-                  .invalidate_files( to_invalidate )
+          config.invalidator.invalidate_files( to_invalidate )
+        end
       end
 
       # create the root dir on remote
@@ -353,6 +359,12 @@ module BranchableCDNAssets
           !f.match(/\.manifest$/) && !File.directory?(f)
         end.map do |f|
           f.sub( "#{File.join( Dir.pwd, root )}/", "" )
+        end.select do |f|
+          if config.file_filter
+            config.file_filter.call(f)
+          else
+            true
+          end
         end
       end
 
@@ -361,4 +373,4 @@ module BranchableCDNAssets
       end
 
   end
-end
+end

data/lib/branchable_cdn_assets/file_manager/checks.rb

@@ -36,7 +36,12 @@ module BranchableCDNAssets
           abort
         end
 
-        if !list(:local).empty?
+        if config.allow_local && !(list(:both) - list(:local)).empty?
+          puts "local assets detected that aren't on the cdn\n" +
+               "you should push or remove them to continue\n" +
+               "  " + (list(:both) - list(:local)).join("\n  ")
+          abort
+        elsif !list(:local).empty?
           puts "assets detected in the local cdn directory\n" +
                "remove them by running the `prune` task"
           abort
@@ -45,4 +50,4 @@ module BranchableCDNAssets
 
     end
   end
-end
+end

data/lib/branchable_cdn_assets/invalidator.rb

@@ -0,0 +1,24 @@
+module BranchableCDNAssets
+  module Invalidator
+
+    class << self
+      def invalidators
+        @_invalidators ||= {}
+        return @_invalidators
+      end
+
+      def register invalidator_key, invalidator_class
+        invalidators[invalidator_key] = invalidator_class
+      end
+
+      def find invalidator_key
+        invalidators.fetch invalidator_key, false
+      end
+    end
+
+  end
+end
+
+require_relative 'invalidator/base'
+require_relative 'invalidator/cloudfront'
+require_relative 'invalidator/akamai_ccu'

data/lib/branchable_cdn_assets/invalidator/akamai_ccu.rb

@@ -0,0 +1,63 @@
+module BranchableCDNAssets
+  module Invalidator
+    class AkamaiCCU < Base
+
+      PURGE_PATH  = '/ccu/v2/queues'.freeze
+      STATUS_PATH = '/ccu/v2/queues'.freeze
+      PURGE_STATUS_PATH = '/ccu/v2/purges'.freeze
+
+      register_as :akamai
+      require_keys [:base_url, :access_token, :client_token, :secret_token]
+
+      set_defaults domain: 'production',
+                   queue_name: 'default'
+
+      def invalidate_files files
+        url  = File.join( config.base_url, PURGE_PATH, config.queue_name )
+        resp = HTTP.post( { access_token: config.access_token,
+                            client_token: config.client_token,
+                            secret_token: config.secret_token
+                          }.merge(  url: url,
+                                    body: {
+                                      action: 'invalidate',
+                                      domain: config.domain,
+                                      objects: Array(files)
+                                    }))
+
+
+        if resp.code.to_i == 201
+          puts "Posted invalidation for #{files.count} files:"
+        else
+          puts "Invalidation failed:"
+        end
+
+        JSON.parse(resp.body).each do |k,v|
+          puts "-> #{k}: #{v}"
+        end
+      end
+
+      # queue status or purge status
+      def status id=nil
+        if id
+          resp = HTTP.get({ access_token: config.access_token,
+                            client_token: config.client_token,
+                            secret_token: config.secret_token
+                          }.merge(  url: File.join( config.base_url, PURGE_STATUS_PATH, id ) ))
+        else
+          resp =  HTTP.get({ access_token: config.access_token,
+                             client_token: config.client_token,
+                             secret_token: config.secret_token
+                           }.merge(  url: File.join( config.base_url, STATUS_PATH, config.queue_name ) ))
+        end
+
+        puts "Status:"
+        JSON.parse(resp.body).each do |k,v|
+          puts "-> #{k}: #{v}"
+        end
+      end
+
+    end
+  end
+end
+
+require_relative 'akamai_ccu/http'

data/lib/branchable_cdn_assets/invalidator/akamai_ccu/http.rb

@@ -0,0 +1,116 @@
+require 'openssl'
+require 'securerandom'
+require 'base64'
+require 'json'
+require 'net/http'
+
+# examples for setting auth headers taken from akamai's edgrid wrapper
+# https://github.com/akamai-open/AkamaiOPEN-edgegrid-ruby/blob/master/lib/akamai/edgegrid.rb
+#
+module BranchableCDNAssets
+  module Invalidator
+    class AkamaiCCU
+
+      class HTTP
+
+        attr_reader :ident, :time, :nonce,
+                    :client_token, :access_token, :secret_token
+
+        def self.get opts={}
+          uri  = URI.parse opts.fetch(:url)
+          http = Net::HTTP.new uri.host, uri.port
+          http.use_ssl = true
+
+          request = Net::HTTP::Get.new(opts.fetch(:url))
+          signed  = self.new(opts).sign(request)
+
+          return http.request signed
+        end
+
+        # opts requires:
+        #   action
+        #   url
+        #   and required keys for HTTP
+        #
+        def self.post opts={}
+          uri  = URI.parse opts.fetch(:url)
+          http = Net::HTTP.new uri.host, uri.port
+          http.use_ssl = true
+
+          request = Net::HTTP::Post.new(  opts.fetch(:url),
+                                          'Content-Type' => 'application/json' )
+
+          request.body = opts.fetch(:body).to_json
+          signed       = self.new(opts).sign(request)
+
+          return http.request signed
+        end
+
+        def initialize opts={}
+          @ident = 'EG1-HMAC-SHA256'
+          @time  = Time.now
+          @nonce = SecureRandom.uuid
+
+          @client_token = opts[:client_token]
+          @access_token = opts[:access_token]
+          @secret_token = opts[:secret_token]
+        end
+
+        def formatted_time
+          time.utc.strftime('%Y%m%dT%H:%M:%S+0000')
+        end
+
+        # return a signed http_request
+        def sign http_request
+          unsigned_auth_header = "#{ident} client_token=#{client_token};" +
+                                 "access_token=#{access_token};" +
+                                 "timestamp=#{formatted_time};"  +
+                                 "nonce=#{nonce};"
+
+          uri         = URI(http_request.path)
+          auth_header = base64_hmac_sha256 [  http_request.method,
+                                              uri.scheme,
+                                              http_request.key?('host') ? http_request['host'] : uri.host,
+                                              uri.request_uri,
+                                              '',
+                                              content_hash(http_request),
+                                              unsigned_auth_header ].join("\t"),
+                                           base64_hmac_sha256( formatted_time, secret_token )
+
+
+
+          http_request['Authorization'] = "#{unsigned_auth_header}signature=#{auth_header}"
+
+          return http_request
+        end
+
+        private
+
+          def content_hash http_request
+            if http_request.method == 'POST' && http_request.body && http_request.body.length > 0
+              if http_request.body.length > 2048
+                body = http_request.body[0..2047]
+              else
+                body = http_request.body
+              end
+
+              return base64_sha256(body)
+            else
+              return ""
+            end
+          end
+
+          def base64_sha256 data
+            Base64.encode64( OpenSSL::Digest::SHA256.new.digest(data) ).strip
+          end
+
+          def base64_hmac_sha256 data, key
+            Base64.encode64( OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, key, data) ).strip
+          end
+
+      end
+    end
+  end
+end
+
+

data/lib/branchable_cdn_assets/invalidator/base.rb

@@ -0,0 +1,45 @@
+module BranchableCDNAssets
+  module Invalidator
+    class Base
+
+      class << self
+        def register_as key
+          BranchableCDNAssets::Invalidator.register key, self
+        end
+
+        def require_keys keys
+          @required_keys = Array(keys)
+        end
+
+        def required_keys
+          @required_keys ||= []
+        end
+
+        def set_defaults opts={}
+          @defaults = opts
+        end
+
+        def defaults
+          @defaults ||= {}
+        end
+      end
+
+      attr_reader :config
+
+      def initialize config_opts={}
+        config_opts = self.class.defaults.merge config_opts
+        unless (self.class.required_keys - config_opts.keys).empty?
+          raise ArgumentError, "Missing required config keys: [#{(self.class.required_keys - config_opts.keys).join(', ')}]"
+        end
+
+        @config = Struct.new("Config_#{object_id}", *config_opts.keys).new(*config_opts.values)
+      end
+
+      # @param files [Array]
+      def invalidate_files files
+        raise NoMethodError, "invalidate_files hasn't been implemented for #{self.class}"
+      end
+
+    end
+  end
+end

data/lib/branchable_cdn_assets/invalidator/cloudfront.rb

@@ -0,0 +1,25 @@
+module BranchableCDNAssets
+  module Invalidator
+    class Cloudfront < Base
+
+      register_as :cloudfront
+      require_keys [:distribution_id, :access_key, :secret_key]
+
+      def cdn
+        @cdn ||= ::Fog::CDN.new provider: 'AWS',
+                                aws_access_key_id: config.access_key,
+                                aws_secret_access_key: config.secret_key
+      end
+
+      # invalidate a batch of files on fog
+      # @param files [Array]
+      def invalidate_files files
+        resp = cdn.post_invalidation( config.distribution_id, Array(files) )
+        resp.body["InvalidationBatch"]["Path"].each do |file|
+          puts "Posted an invalidation for #{file}".colorize( :green )
+        end
+      end
+
+    end
+  end
+end

data/lib/branchable_cdn_assets/manifest.rb

@@ -55,9 +55,9 @@ module BranchableCDNAssets
 
       # remove the manifest source_file
       def destroy!
-        File.delete(source_file)
+        File.delete(source_file) if File.exist?(source_file)
         true
       end
 
   end
-end
+end

data/lib/branchable_cdn_assets/version.rb

@@ -1,3 +1,3 @@
 module BranchableCDNAssets
-  VERSION = "0.6.1"
-end
+  VERSION = "0.7.0"  unless defined?(BranchableCDNAssets::VERSION)
+end

data/spec/lib/branchable_cdn_assets/config_spec.rb

@@ -11,7 +11,15 @@ describe BranchableCDNAssets::Config do
         production: {
           host: 'production',
           url:  'http://production.com',
-          root: '/var/www/production'
+          root: '/var/www/production',
+          invalidator: {
+            cloudfront: {
+              access_key:      'FooBar',
+              secret_key:      'SecretBaz',
+              distribution_id: 'Distro',
+              path_prefix:     '/'
+            }
+          }
         },
         test: {
           host: 'test',
@@ -28,12 +36,6 @@ describe BranchableCDNAssets::Config do
           url:  'http://default.com',
           root: '/var/www/default'
         }
-      },
-      cloudfront: {
-        access_key:   'FooBar',
-        secret_key:   'SecretBaz',
-        distribution: 'Distro',
-        path_prefix:  '/'
       }
     }
   end
@@ -98,9 +100,26 @@ describe BranchableCDNAssets::Config do
     end
   end
 
-  describe "#cloudfront" do
-    it "is set to the passed value" do
-      expect( described_class.new( data ).cloudfront ).to eq data[:cloudfront]
+  describe "#invalidator" do
+
+    it "returns instance of given invalidator class" do
+      expect( described_class.new( data, 'production' ).invalidator ).to be_a BranchableCDNAssets::Invalidator::Cloudfront
+    end
+
+    it "returns false if no invalidator given" do
+      subject_data = data.dup
+      subject_data[:environments][:production].delete(:invalidator)
+
+      expect( described_class.new( subject_data, 'production' ).invalidator ).to be false
+    end
+
+    it "raises error if given an unregistered invalidator" do
+      subject_data = data.dup
+      subject_data[:environments][:production][:invalidator] = { foo: 'bar' }
+
+      expect{
+        described_class.new(subject_data, 'production').invalidator
+      }.to raise_error
     end
   end
 
@@ -114,6 +133,27 @@ describe BranchableCDNAssets::Config do
     end
   end
 
+  describe "#file_filter" do
+    it "returns nil if not set" do
+      expect( described_class.new( data ).file_filter ).to eq nil
+    end
+
+    it "raises an argument error if not a proc with one argument" do
+      expect{
+        described_class.new( data.merge(file_filter: "foo") )
+      }.to raise_error ArgumentError
+
+      expect{
+        described_class.new( data.merge(file_filter: lambda { |x,y| } ) )
+      }.to raise_error ArgumentError
+    end
+
+    it "returns the given proc" do
+      filter_proc = lambda { |file_path| file_path }
+      expect( described_class.new( data.merge(file_filter: filter_proc) ).file_filter ).to eq filter_proc
+    end
+  end
+
   describe "#env" do
     context "when the current branch matches production_branch" do
       before :each do
@@ -159,4 +199,4 @@ describe BranchableCDNAssets::Config do
     end
   end
 
-end
+end

data/spec/lib/branchable_cdn_assets/file_manager/find_spec.rb

@@ -30,6 +30,22 @@ describe BranchableCDNAssets::FileManager do
       it "returns nil if asset is missing" do
         expect( @manager.find('missing') ).to be_nil
       end
+
+      it "returns :local if told to look local and file exists" do
+        expect( @manager.find('image_one', :local) ).to eq :local
+      end
+
+      it "returns nil if told to look local and file only on remote" do
+        expect( @manager.find('image_remote_one', :local) ).to be_nil
+      end
+
+      it "returns remote file if told to look remote and file exists on both" do
+        expect( @manager.find('image_one', :remote) ).to eq 'http://production.com/image_one'
+      end
+
+      it "returns nil if told to look remote and file only local" do
+        expect( @manager.find('image_two', :remote) ).to be_nil
+      end
     end
 
     context "when on staging branch" do
@@ -54,8 +70,28 @@ describe BranchableCDNAssets::FileManager do
       it "returns nil if asset is missing" do
         expect( @manager.find('missing') ).to be_nil
       end
+
+      it "returns :local if told to look local and file exists" do
+        expect( @manager.find('image_one', :local) ).to eq :local
+      end
+
+      it "returns nil if told to look local and file only on remote" do
+        expect( @manager.find('image_remote_one', :local) ).to be_nil
+      end
+
+      it "returns remote file if told to look remote and file exists on both" do
+        expect( @manager.find('image_one', :remote) ).to eq 'http://staging.com/staging/image_one'
+      end
+
+      it "returns production file if told to look remote and file exists only on prod" do
+        expect( @manager.find('image_remote_one', :remote) ).to eq 'http://production.com/image_remote_one'
+      end
+
+      it "returns nil if told to look remote and file only local" do
+        expect( @manager.find('image_two', :remote) ).to be_nil
+      end
     end
 
   end
 
-end
+end

data/spec/lib/branchable_cdn_assets/file_manager_spec.rb

@@ -5,22 +5,35 @@ describe BranchableCDNAssets::FileManager do
   before :each do
     @config_data = {
       env: 'default',
-      branch: 'branch',
       cdn_dir: 'cdn',
-      host: 'host',
-      root: 'root',
-      manage_cloudfront: true,
       dir_permissions: 755,
       file_permissions: 644,
       rsync_flags: '-aviz',
       remotes: [
         BranchableCDNAssets::Config::Remote.new( 'host', 'root', 'url', 755, 644, '-aviz' )
       ],
-      cloudfront: {
-        path_prefix: '/prefix'
+      environments: {
+        staging: {
+          host: 'host',
+          root: 'root',
+          url: 'http://foo.com'
+        },
+        production: {
+          host: 'host',
+          root: 'root',
+          url: 'http://foo.com',
+          invalidator: {
+            cloudfront: {
+              distribution_id: '',
+              access_key: '',
+              secret_key: '',
+              path_prefix: '/prefix'
+            }
+          }
+        }
       }
     }
-    @config = instance_double( "BranchableCDNAssets::Config", @config_data )
+    @config = BranchableCDNAssets::Config.new @config_data, 'master'
     allow( BranchableCDNAssets::Config ).to receive(:new).and_return( @config )
 
     @file_list = [
@@ -35,8 +48,9 @@ describe BranchableCDNAssets::FileManager do
     @manifest = instance_double("BranchableCDNAssets::Manifest", files: @file_list )
     allow( BranchableCDNAssets::Manifest ).to receive(:new).and_return( @manifest )
 
-    @cloudfront = instance_double("BranchableCDNAssets::Cloudfront")
-    allow( BranchableCDNAssets::Cloudfront ).to receive(:new).and_return( @cloudfront )
+    @cloudfront = BranchableCDNAssets::Invalidator::Cloudfront.new(@config_data[:environments][:production][:invalidator][:cloudfront])
+    allow( BranchableCDNAssets::Invalidator::Cloudfront ).to receive(:new).and_return( @cloudfront )
+    allow( @cloudfront ).to receive(:invalidate_files)
 
     @tempfile = instance_double( "Tempfile",
       unlink: nil,
@@ -89,8 +103,10 @@ describe BranchableCDNAssets::FileManager do
         cdn_dir: 'cdn',
         host: 'host',
         root: 'root',
-        cloudfront: {
-          path_prefix: '/prefix'
+        invalidator: {
+          cloudfront: {
+            path_prefix: '/prefix'
+          }
         }
       }
       @config = instance_double( "BranchableCDNAssets::Config", @config_data )
@@ -127,6 +143,16 @@ describe BranchableCDNAssets::FileManager do
       expect( described_class.new(@config).list(:local) ).to match_array local_files
     end
 
+    it "uses the given file_filter to filter files when :local" do
+      file_filter = lambda { |file_path| return !file_path.match('directory') }
+      @config = instance_double( "BranchableCDNAssets::Config",
+                                 @config_data.merge( file_filter: file_filter,
+                                                     branch: 'master' ) )
+      allow( BranchableCDNAssets::Config ).to receive(:new).and_return( @config )
+
+      expect( described_class.new( @config ).list(:local) ).to match_array local_files - ['directory/dir_file']
+    end
+
     it "returns both local and remote files when :all" do
       expect( described_class.new(@config).list() ).to match_array remote_files + local_files
     end

data/spec/lib/branchable_cdn_assets/invalidator/base_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe BranchableCDNAssets::Invalidator::Base do
+
+  after :each do
+    Object.send(:remove_const, :Foo) if defined? Foo
+  end
+
+  describe "::register_as" do
+    it "calls register with given key on BranchableCDNAssets::Invalidator" do
+      class Foo < BranchableCDNAssets::Invalidator::Base; end
+      expect( BranchableCDNAssets::Invalidator ).to receive(:register)
+                                                .with(:foo, Foo)
+
+      class Foo
+        register_as :foo
+      end
+    end
+  end
+
+  describe "::require_keys" do
+    it "sets class.required_keys" do
+      class Foo < BranchableCDNAssets::Invalidator::Base
+        require_keys [:foo, :bar]
+      end
+
+      expect( Foo.required_keys ).to match_array [:foo, :bar]
+    end
+  end
+
+  describe "::set_defaults" do
+    it "sets class.defaults" do
+      class Foo < BranchableCDNAssets::Invalidator::Base
+        set_defaults foo: 'bar'
+      end
+
+      expect( Foo.defaults ).to eq foo: 'bar'
+    end
+  end
+
+  describe "#initialize" do
+    it "takes a hash and converts to config struct" do
+      config = {
+        foo: 'bar',
+        wu:  'tang'
+      }
+
+      subject = described_class.new(config)
+
+      expect( subject.config.foo ).to eq 'bar'
+      expect( subject.config.wu ).to  eq 'tang'
+    end
+
+    it "uses defaults for key if key not given" do
+      class Foo < BranchableCDNAssets::Invalidator::Base
+        set_defaults foo: 'bar'
+      end
+
+      subject = Foo.new baz: 'bang'
+      expect( subject.config.foo ).to eq 'bar'
+    end
+
+    it "given value even if default given" do
+      class Foo < BranchableCDNAssets::Invalidator::Base
+        set_defaults foo: 'bar'
+      end
+
+      subject = Foo.new foo: 'bang'
+      expect( subject.config.foo ).to eq 'bang'
+    end
+
+    it "raises ArgumentError if missing required keys" do
+      class Foo < BranchableCDNAssets::Invalidator::Base
+        require_keys [:boom]
+      end
+
+      expect{
+        Foo.new foo: 'bar'
+      }.to raise_error ArgumentError
+    end
+  end
+
+  describe "#invalidate_files" do
+    it "raises a NoMethodError, it's not implemented" do
+      expect{
+        described_class.new.invalidate_files('foo')
+      }.to raise_error NoMethodError
+    end
+  end
+
+end

data/spec/lib/{cloudfront_spec.rb → branchable_cdn_assets/invalidator/cloudfront_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe BranchableCDNAssets::Cloudfront do
+describe BranchableCDNAssets::Invalidator::Cloudfront do
 
-  let(:keys) do
+  let(:config) do
     {
       distribution_id: 'dist_id',
       access_key: 'access_key',
@@ -13,19 +13,22 @@ describe BranchableCDNAssets::Cloudfront do
   describe "#initialize" do
 
     before :each do
-      @subject = described_class.new(keys)
+      @subject = described_class.new(config)
     end
 
     it "sets #distribution_id" do
-      expect( @subject.distribution_id ).to eq 'dist_id'
+      expect( @subject.config.distribution_id ).to eq 'dist_id'
     end
     it "sets #access_key" do
-      expect( @subject.access_key ).to eq 'access_key'
+      expect( @subject.config.access_key ).to eq 'access_key'
     end
     it "sets #secret_key" do
-      expect( @subject.secret_key ).to eq 'secret_key'
+      expect( @subject.config.secret_key ).to eq 'secret_key'
     end
 
+  end
+
+  describe "#cdn" do
     it "sets #cdn with a Fog instance" do
       fog = double("Fog::CDN")
       expect( Fog::CDN ).to receive(:new).with(
@@ -33,9 +36,8 @@ describe BranchableCDNAssets::Cloudfront do
         aws_access_key_id: 'access_key',
         aws_secret_access_key: 'secret_key'
       ).and_return(fog)
-      expect( described_class.new(keys).cdn ).to eq fog
+      expect( described_class.new(config).cdn ).to eq fog
     end
-
   end
 
   describe "#invalidate_files" do
@@ -51,7 +53,7 @@ describe BranchableCDNAssets::Cloudfront do
         aws_access_key_id: 'access_key',
         aws_secret_access_key: 'secret_key'
       ).and_return(@fog)
-      @subject = described_class.new(keys)
+      @subject = described_class.new(config)
     end
 
     it "calls cloudfront to invalidate given files" do

data/spec/lib/branchable_cdn_assets/invalidator_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe BranchableCDNAssets::Invalidator do
+
+  def clean_invalidators
+    described_class.instance_variable_set :@_invalidators, nil
+  end
+
+  def clean_foo_class
+    Object.send(:remove_const, :Foo) if defined? Foo
+  end
+
+  before :each do
+    clean_invalidators
+  end
+
+  after :each do
+    clean_foo_class
+  end
+
+  describe "::invalidators" do
+    it "returns empty hash if no invalidators are registered" do
+      expect( described_class.invalidators ).to eq({})
+    end
+    it "returns hash of registered invalidators" do
+      class Foo < BranchableCDNAssets::Invalidator::Base
+        register_as :foo
+      end
+      expect( described_class.invalidators ).to eq({foo: Foo})
+    end
+  end
+
+  describe "::register" do
+    it "adds invalidator to invalidators hash" do
+      class Foo; end
+      described_class.register :foo, Foo
+      expect( described_class.invalidators ).to eq({foo: Foo})
+    end
+  end
+
+  describe "::find" do
+    it "returns invalidator class if one is registered" do
+      class Foo; end
+      described_class.register :foo, Foo
+
+      expect( described_class.find(:foo) ).to eq Foo
+    end
+    it "returns false if invalidator isn't registered" do
+      expect( described_class.find(:bar) ).to eq false
+    end
+  end
+
+end

data/spec/lib/branchable_cdn_assets/manifest_spec.rb

@@ -108,6 +108,7 @@ describe BranchableCDNAssets::Manifest do
         manifest = BranchableCDNAssets::Manifest.new('foo')
 
         expect( File ).not_to receive(:open)
+        allow( File ).to receive(:exist?).with('foo').and_return(true)
         expect( File ).to receive(:delete).with('foo')
 
         manifest.update_source_file!
@@ -135,4 +136,4 @@ describe BranchableCDNAssets::Manifest do
   end
 
 
-end
+end

metadata

@@ -1,86 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: branchable_cdn_assets
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: asgit
   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: here_or_there
   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: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
-description: ' Helpers for syncing and finding assets accross multiple remotes '
+description: " Helpers for syncing and finding assets accross multiple remotes "
 email: marketing-dev@mailchimp.com
 executables: []
 extensions: []
@@ -88,12 +88,16 @@ extra_rdoc_files: []
 files:
 - lib/branchable_cdn_assets.rb
 - lib/branchable_cdn_assets/check_before.rb
-- lib/branchable_cdn_assets/cloudfront.rb
 - lib/branchable_cdn_assets/config.rb
 - lib/branchable_cdn_assets/config/environment_attribute_reader.rb
 - lib/branchable_cdn_assets/file_manager.rb
 - lib/branchable_cdn_assets/file_manager/checks.rb
 - lib/branchable_cdn_assets/file_manager/permissions.rb
+- lib/branchable_cdn_assets/invalidator.rb
+- lib/branchable_cdn_assets/invalidator/akamai_ccu.rb
+- lib/branchable_cdn_assets/invalidator/akamai_ccu/http.rb
+- lib/branchable_cdn_assets/invalidator/base.rb
+- lib/branchable_cdn_assets/invalidator/cloudfront.rb
 - lib/branchable_cdn_assets/manifest.rb
 - lib/branchable_cdn_assets/rake_tasks.rb
 - lib/branchable_cdn_assets/shell.rb
@@ -103,10 +107,12 @@ files:
 - spec/lib/branchable_cdn_assets/config_spec.rb
 - spec/lib/branchable_cdn_assets/file_manager/find_spec.rb
 - spec/lib/branchable_cdn_assets/file_manager_spec.rb
+- spec/lib/branchable_cdn_assets/invalidator/base_spec.rb
+- spec/lib/branchable_cdn_assets/invalidator/cloudfront_spec.rb
+- spec/lib/branchable_cdn_assets/invalidator_spec.rb
 - spec/lib/branchable_cdn_assets/manifest_spec.rb
 - spec/lib/branchable_cdn_assets/rake_tasks_spec.rb
 - spec/lib/branchable_cdn_assets_spec.rb
-- spec/lib/cloudfront_spec.rb
 - spec/spec_helper.rb
 - spec/support/given.rb
 - spec/support/hash.rb
@@ -120,17 +126,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Helpers for syncing and finding assets accross multiple remotes
@@ -140,10 +146,12 @@ test_files:
 - spec/lib/branchable_cdn_assets/config_spec.rb
 - spec/lib/branchable_cdn_assets/file_manager/find_spec.rb
 - spec/lib/branchable_cdn_assets/file_manager_spec.rb
+- spec/lib/branchable_cdn_assets/invalidator/base_spec.rb
+- spec/lib/branchable_cdn_assets/invalidator/cloudfront_spec.rb
+- spec/lib/branchable_cdn_assets/invalidator_spec.rb
 - spec/lib/branchable_cdn_assets/manifest_spec.rb
 - spec/lib/branchable_cdn_assets/rake_tasks_spec.rb
 - spec/lib/branchable_cdn_assets_spec.rb
-- spec/lib/cloudfront_spec.rb
 - spec/spec_helper.rb
 - spec/support/given.rb
 - spec/support/hash.rb

data/lib/branchable_cdn_assets/cloudfront.rb

@@ -1,28 +0,0 @@
-module BranchableCDNAssets
-  class Cloudfront
-
-    attr_reader :access_key, :secret_key, :distribution_id,
-                :cdn
-
-    # handles communication with cloudfront
-    def initialize keys
-      @distribution_id = keys.fetch :distribution_id
-      @access_key      = keys.fetch :access_key
-      @secret_key      = keys.fetch :secret_key
-
-      @cdn = ::Fog::CDN.new provider: 'AWS',
-                            aws_access_key_id: access_key,
-                            aws_secret_access_key: secret_key
-    end
-
-    # invalidate a batch of files on fog
-    # @param files [Array]
-    def invalidate_files files
-      resp = cdn.post_invalidation( distribution_id, Array(files) )
-      resp.body["InvalidationBatch"]["Path"].each do |file|
-        puts "Posted an invalidation for #{file}".colorize( :green )
-      end
-    end
-
-  end
-end