cloudfront-invalidator 0.1.2 → 0.2.0

data/README.md

@@ -0,0 +1,24 @@
+Usage
+=====
+
+    invalidator = CloudfrontInvalidator.new(AWS_KEY, AWS_SECRET, CF_DISTRIBUTION_ID)
+    list = %w[
+      index.html
+      favicon.ico
+    ]
+    invalidator.invalidate(list) do |status,time|   # Block is optional.
+      invalidator.list                              # Or invalidator.list_detail
+      puts "Complete after < #{time.to_f.ceil} seconds." if status == "Complete"
+    end
+
+A command line utility is also included.
+
+    $ cloudfront-invalidator invalidate $AWS_KEY $AWS_SECRET $DISTRIBUTION_ID index.html favicon.ico
+    $ cloudfront-invalidator list $AWS_KEY $AWS_SECRET $DISTRIBUTION_ID
+    $ cloudfront-invalidator list_detail $AWS_KEY $AWS_SECRET $DISTRIBUTION_ID
+
+Authors
+=======
+
+* Reid M Lynch
+* Jacob Elder

data/bin/cloudfront-invalidator

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+begin
+  require '../lib/cloudfront-invalidator'
+rescue LoadError
+  require 'rubygems'
+  require 'cloudfront-invalidator'
+end
+
+unless ARGV.length >= 4
+  warn "Usage: cloudfront-invalidator (invalidate|list|list_detail) aws_key aws_secret distribution_id [path ...]"
+  exit 1
+end
+
+verb            = ARGV.shift
+raise "Verb must be invalidate, list, or list_detail" unless %w{invalidate list list_detail}.include? verb
+aws_key         = ARGV.shift
+aws_secret      = ARGV.shift
+distribution_id = ARGV.shift
+paths = ARGV
+
+invalidator = CloudfrontInvalidator.new(aws_key, aws_secret, distribution_id)
+case verb
+when 'invalidate'
+  print "Invalidating #{paths.size} objects"
+  invalidator.invalidate(paths) do |status,time|
+    print status == "Complete" ? "\nComplete after < #{time.to_f.ceil} seconds.\n" : "."
+  end
+when 'list'
+  invalidator.list
+when 'list_detail'
+  invalidator.list_detail
+end

data/lib/cloudfront-invalidator.rb

@@ -1,9 +1,15 @@
-require 'net/http'
+require 'net/https'
 require 'base64'
-require 'hmac-sha1'
+require 'rexml/document'
+require 'hmac-sha1' # this is a gem
+
+class CloudfrontInvalidator  
+  API_VERSION = '2012-05-05'
+  BASE_URL = "https://cloudfront.amazonaws.com/#{API_VERSION}/distribution/"
+  DOC_URL = "http://cloudfront.amazonaws.com/doc/#{API_VERSION}/"
+  BACKOFF_LIMIT = 8192
+  BACKOFF_DELAY = 0.025
 
-class CloudfrontInvalidator
-  
   def initialize(aws_key, aws_secret, cf_dist_id)
     @aws_key, @aws_secret, @cf_dist_id = aws_key, aws_secret, cf_dist_id
   end
@@ -13,23 +19,111 @@ class CloudfrontInvalidator
       k.start_with?('/') ? k : '/' + k 
     end
     
-    uri = URI.parse "https://cloudfront.amazonaws.com/2010-11-01/distribution/#{@cf_dist_id}/invalidation"
+    uri = URI.parse "#{BASE_URL}#{@cf_dist_id}/invalidation"
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = true
     http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     body = xml_body(keys)
-    resp = http.send_request 'POST', uri.path, body, headers
-    puts resp.code
-    puts resp.body
+
+    delay = 1
+    begin
+      resp = http.send_request 'POST', uri.path, body, headers
+      doc = REXML::Document.new resp.body
+   
+      # Create and raise an exception for any error the API returns to us.
+      if resp.code.to_i != 201
+        error_code = doc.elements["ErrorResponse/Error/Code"].text
+        self.class.const_set(error_code,Class.new(StandardError)) unless self.class.const_defined?(error_code.to_sym)
+        raise self.class.const_get(error_code).new(doc.elements["ErrorResponse/Error/Message"].text)
+      end
+    
+    # Handle the common case of too many in progress by waiting until the others finish.
+    rescue TooManyInvalidationsInProgress => e
+      sleep delay * BACKOFF_DELAY
+      delay *= 2 unless delay >= BACKOFF_LIMIT 
+      STDERR.puts e.inspect
+      retry
+    end
+
+    # If we are passed a block, poll on the status of this invalidation with truncated exponential backoff.
+    if block_given?
+      invalidation_id = doc.elements["Invalidation/Id"].text
+      poll_invalidation(invalidation_id) do |status,time|
+        yield status, time
+      end
+    end
+    return resp
   end
-  
+
+  def poll_invalidation(invalidation_id)
+    start = Time.now
+    delay = 1
+    loop do
+      doc = REXML::Document.new get_invalidation_detail_xml(invalidation_id)
+      status = doc.elements["Invalidation/Status"].text
+      yield status, Time.now - start
+      break if status != "InProgress"
+      sleep delay * BACKOFF_DELAY
+      delay *= 2 unless delay >= BACKOFF_LIMIT
+    end
+  end
+
+  def list(show_detail = false)
+    uri = URI.parse "#{BASE_URL}#{@cf_dist_id}/invalidation"
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    resp = http.send_request 'GET', uri.path, '', headers
+
+    doc = REXML::Document.new resp.body
+    puts "MaxItems " + doc.elements["InvalidationList/MaxItems"].text + "; " + (doc.elements["InvalidationList/MaxItems"].text == "true" ? "truncated" : "not truncated")
+
+    doc.each_element("/InvalidationList/InvalidationSummary") do |summary|
+      invalidation_id = summary.elements["Id"].text
+      summary_text = "ID " + invalidation_id + ": " + summary.elements["Status"].text
+
+      if show_detail
+        detail_doc = REXML::Document.new get_invalidation_detail_xml(invalidation_id)
+        puts summary_text +
+             "; Created at: " +
+             detail_doc.elements["Invalidation/CreateTime"].text +
+             '; Caller reference: "' +
+             detail_doc.elements["Invalidation/InvalidationBatch/CallerReference"].text +
+             '"'
+        puts '  Invalidated URL paths:'
+        
+        puts "    " + detail_doc.elements.to_a('Invalidation/InvalidationBatch/Path').map { |path| path.text }.join(" ")
+      else
+        puts summary_text
+      end
+    end
+  end
+
+  def list_detail
+    list(true)
+  end
+
+  def get_invalidation_detail_xml(invalidation_id)
+    uri = URI.parse "#{BASE_URL}#{@cf_dist_id}/invalidation/#{invalidation_id}"
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    resp = http.send_request 'GET', uri.path, '', headers
+    return resp.body
+  end
+
   def xml_body(keys)
     xml = <<XML
 <?xml version="1.0" encoding="UTF-8"?>
-  <InvalidationBatch>
-    #{keys.map{|k| "<Path>#{k}</Path>" }.join("\n    ")}
-    <CallerReference>CloudfrontInvalidator at #{Time.now}</CallerReference>"
-  </InvalidationBatch>
+<InvalidationBatch xmlns="#{DOC_URL}">
+  <Paths>
+    <Quantity>#{keys.size}</Quantity>
+    <Items>
+      #{keys.map{|k| "<Path>#{k}</Path>" }.join("\n    ")}
+    </Items>
+  </Paths>
+  <CallerReference>#{self.class.to_s} on #{Socket.gethostname} at #{Time.now.to_i}</CallerReference>"
+</InvalidationBatch>
 XML
   end
   
@@ -40,5 +134,7 @@ XML
     signature = Base64.encode64(digest.digest)
     {'Date' =>  date, 'Authorization' => "AWS #{@aws_key}:#{signature}"}
   end
-  
-end
+
+  class TooManyInvalidationsInProgress < StandardError ; end
+
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: cloudfront-invalidator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
-- Reid M Lynch
+- Jacob Elder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-16 00:00:00.000000000Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
-  requirement: &987040 !ruby/object:Gem::Requirement
+  requirement: &70238974779060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,14 +21,17 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *987040
+  version_requirements: *70238974779060
 description: 
-email: reid.lynch@gmail.com
-executables: []
+email: jacob.elder@gmail.com
+executables:
+- cloudfront-invalidator
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/cloudfront-invalidator.rb
+- README.md
+- bin/cloudfront-invalidator
 homepage: http://github.com/reidiculous/cloudfront-invalidator
 licenses: []
 post_install_message: 
@@ -49,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cloudfront-invalidator
-rubygems_version: 1.8.5
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Simple gem to invalidate a list of keys belonging to a Cloudfront distribution