ipecache 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (March 20, 2013)
+
+Initial version.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    ipecache (0.0.1)
+      app_conf (>= 0.4.0)
+      choice (>= 0.1.6)
+      faraday_middleware (>= 0.9.0)
+      savon (>= 2.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    app_conf (0.4.0)
+    builder (3.0.0)
+    choice (0.1.6)
+    faraday (0.8.6)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    gyoku (1.0.0)
+      builder (>= 2.1.2)
+    httpi (2.0.2)
+      rack
+    multipart-post (1.2.0)
+    nokogiri (1.5.6)
+    nori (2.0.4)
+    rack (1.4.1)
+    savon (2.1.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.0.0)
+      httpi (~> 2.0.2)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.0.3)
+      wasabi (~> 3.0.0)
+    wasabi (3.0.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ipecache!

data/LICENSE

@@ -0,0 +1,13 @@
+Ipecache
+----------
+Author:: Jon Cowie (<jcowie@etsy.com>)
+Copyright:: Copyright (c) 2013 Jon Cowie
+License:: GPL
+
+Plugin API
+----------
+Modified version of code added to knife-spork under the following license:
+
+Author:: Seth Vargo (<svargo@customink.com>)
+Copyright:: Copyright (c) 2012 Seth Vargo
+License:: GPL

data/README.md

@@ -0,0 +1,180 @@
+Ipecache
+===========
+Ipecache is an extensible tool for purging URLs from Caches and CDNs.
+
+Installation
+------------
+### Gem Install (recommended)
+`ipecache` is available on rubygems. Add the following to your `Gemfile`:
+
+```ruby
+gem 'ipecache'
+```
+
+or install the gem manually:
+
+```bash
+gem install ipecache
+```
+
+Ipecache Configuration
+-------------------
+Ipecache will not work with no configuration, so before you can purge anything, you'll need to specify some configuration for the plugins you wish to use.
+
+Ipecache will look for a configuration file in the following locations, in ascending order of precedence:
+
+- `/etc/ipecache-config.yml`
+- `~/.ipecache/ipecache-config.yml`
+
+Anything set in the configuration file in your home directory for example, will override options set in `/etc`.
+
+Below is a sample config file with all supported options and all shipped plugins enabled below, followed by an explanation of each section.
+
+Please note, if you do not want to use a particular plugin, don't specify any configuration for it and it will automatically be disabled.
+
+```yaml
+plugins:
+  atschef:
+    knife_config: /my/.chef/knife.rb
+    chef_role: ATSRole
+  fastly:
+    api_key: abc123abc123abc123abc123abc123abc123
+  edgecast:
+    account_id: 1A2B
+    api_key: abc123
+  akamai:
+    username: myusername
+    password: mypassword
+```
+
+#### atschef
+For more information on how to configure the ATS/Chef plugin, please read the [plugins/ATSChef.md](plugins/ATSChef.md) file.
+
+#### Fastly
+For more information on how to configure the Fastly CDN plugin, please read the [plugins/Fastly.md](plugins/Fastly.md) file.
+
+#### Edgecast
+For more information on how to configure the Edgecast CDN plugin, please read the [plugins/Edgecast.md](plugins/Edgecast.md) file.
+
+#### Akamai
+For more information on how to configure the Akamai plugin, please read the [plugins/Akamai.md](plugins/Akamai.md) file.
+
+
+
+Ipecache Usage
+-----------
+The main component of Ipecache, and the program which initialises and calls all plugins is called `ipecache`.
+
+#### Usage
+```bash
+ipecache [-f -u -c -p --status]
+```
+
+* Mandatory Parameters (you must specify one or the other)
+    * -f: Specifies a file containg a newline seperated list of URLS to purge
+    * -u: Specifies a single URL to purge
+
+* Optional Parameters:
+    * --status: Prints the status of all ipecache plugins
+    * -c: Indicates that only CDN plugins should be run
+    * -p: Indicates that only local proxy plugins should be run.
+
+
+#### Example (Checking plugin status)
+
+```text
+$> ipecache --status
+Ipecache Status:
+
+Ipecache::Plugins::Akamai: enabled
+Ipecache::Plugins::ATSChef: enabled
+Ipecache::Plugins::Edgecast: enabled
+Ipecache::Plugins::Fastly: enabled
+```
+
+#### Example (Purging a single URL from local proxies only)
+
+```text
+$> ipecache -u https://img3.etsystatic.com/000/0/5241384/il_340x270.220445599.jpg -p
+
+Running plugins registered for Proxy Purge...
+
+
+Ipecache::Plugins::ATSChef: Beginning URL Purge from ATS...
+Ipecache::Plugins::ATSChef: Finding ATS Servers...
+Ipecache::Plugins::ATSChef: Purging https://img.mydomain.com/image9.jpg
+Ipecache::Plugins::ATSChef: --Purge from cache1.mydomain.com not needed, asset not found
+Ipecache::Plugins::ATSChef: --Purged from cache2.mydomain.com sucessfully
+
+All done!
+```
+
+#### Example (Purging a file containing 2 URLs from CDNS only)
+
+```text
+$>  ipecache -f ~/urlfile -c
+
+   Running plugins registered for CDN Purge...
+
+
+   Ipecache::Plugins::Akamai: Beginning URL Purge from Akamai...
+   Ipecache::Plugins::Akamai: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::Akamai: Purge successful!
+   Ipecache::Plugins::Akamai: Purging https://img.mydomain.com/image10.jpg
+   Ipecache::Plugins::Akamai: Purge successful!
+
+   Ipecache::Plugins::Edgecast: Beginning URL Purge from Edgecast...
+   Ipecache::Plugins::Edgecast: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::Edgecast: Purge successful!
+   Ipecache::Plugins::Edgecast: Purging https://img.mydomain.com/image10.jpg
+   Ipecache::Plugins::Edgecast: Purge successful!
+
+   Ipecache::Plugins::Fastly: Beginning URL Purge from Fastly...
+   Ipecache::Plugins::Fastly: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::Fastly: Purge successful!
+   Ipecache::Plugins::Fastly: Purging https://img.mydomain.com/imag10.jpg
+   Ipecache::Plugins::Fastly: Purge successful!
+
+   All done!
+```
+
+#### Example (Purging a file containing 2 URLs from proxies and CDNS)
+
+```text
+$>  ipecache -f ~/urlfile
+
+   Running plugins registered for Proxy Purge...
+
+
+   Ipecache::Plugins::ATSChef: Beginning URL Purge from ATS...
+   Ipecache::Plugins::ATSChef: Finding ATS Servers...
+   Ipecache::Plugins::ATSChef: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::ATSChef: --Purge from cache1.mydomain.com not needed, asset not found
+   Ipecache::Plugins::ATSChef: --Purged from cache2.mydomain.com sucessfully
+   Ipecache::Plugins::ATSChef: Purging https://img.mydomain.com/image10.jpg
+   Ipecache::Plugins::ATSChef: --Purge from cache1.mydomain.com not needed, asset not found
+   Ipecache::Plugins::ATSChef: --Purged from cache2.mydomain.com sucessfully
+
+   Running plugins registered for CDN Purge...
+
+
+   Ipecache::Plugins::Akamai: Beginning URL Purge from Akamai...
+   Ipecache::Plugins::Akamai: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::Akamai: Purge successful!
+   Ipecache::Plugins::Akamai: Purging https://img.mydomain.com/image10.jpg
+   Ipecache::Plugins::Akamai: Purge successful!
+
+   Ipecache::Plugins::Edgecast: Beginning URL Purge from Edgecast...
+   Ipecache::Plugins::Edgecast: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::Edgecast: Purge successful!
+   Ipecache::Plugins::Edgecast: Purging https://img.mydomain.com/image10.jpg
+   Ipecache::Plugins::Edgecast: Purge successful!
+
+   Ipecache::Plugins::Fastly: Beginning URL Purge from Fastly...
+   Ipecache::Plugins::Fastly: Purging https://img.mydomain.com/image9.jpg
+   Ipecache::Plugins::Fastly: Purge successful!
+   Ipecache::Plugins::Fastly: Purging https://img.mydomain.com/imag10.jpg
+   Ipecache::Plugins::Fastly: Purge successful!
+
+   All done!
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/bin/ipecache

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+# ipecache - A command line memcached traffic analyzer
+#
+# Author:: Jon Cowie (<jcowie@etsy.com>)
+
+require 'choice'
+require 'ipecache/runner'
+include Ipecache::Runner
+
+Choice.options do
+  header ""
+  header "Specific options:"
+
+  option :status, :required => false do
+    long  '--status'
+    desc  'Show ipecache status information'
+  end
+
+  option :urlfile, :required => false do
+    short '-f'
+    long  '--file=PATH_TO_URL_FILE'
+    desc  'File containing urls to purge from caches'
+  end
+
+  option :url, :required => false do
+    short '-u'
+    long  '--url=URL_TO_PURGE'
+    desc  'URL to be purged from caches'
+  end
+
+  option :proxyonly, :required => false do
+    short '-p'
+    long  '--proxy-only'
+    desc  'Only purge from proxies'
+  end
+
+  option :cdnonly, :required => false do
+    short '-c'
+    long  '--cdn-only'
+    desc  'Only purge from CDNs'
+  end
+end
+
+if Choice.choices[:status]
+  puts "Ipecache Status:"
+  puts ""
+  Ipecache::Plugins.klasses.each do |klass|
+    plugin = klass.new(:config => ipecache_config)
+    puts "#{klass}: #{plugin.enabled? ? 'enabled' : 'disabled'}"
+  end
+  exit 0
+end
+
+if Choice.choices[:url]
+  @urls = [Choice.choices[:url]]
+elsif  Choice.choices[:urlfile]
+  urlfile = Choice.choices[:urlfile]
+  if File.exists?(urlfile)
+    @urls = File.open(urlfile, 'r').readlines
+  else
+    puts "Error: #{urlfile} doesn't exist."
+    exit 1
+  end
+else
+  Choice.help
+end
+
+if !Choice.choices[:cdnonly]
+  puts ""
+  puts "Running plugins registered for Proxy Purge..."
+  puts ""
+  run_plugins(:proxy_purge)
+end
+
+if !Choice.choices[:proxyonly]
+  puts ""
+  puts "Running plugins registered for CDN Purge..."
+  puts ""
+  run_plugins(:cdn_purge)
+end
+
+puts ""
+puts "All done!"

data/ipecache.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ipecache'
+  gem.version       = '0.0.1'
+  gem.authors       = ["Jon Cowie"]
+  gem.email         = 'jonlives@gmail.com'
+  gem.homepage      = 'https://github.com/jonlives/ipecache'
+  gem.summary       = "An extensible tool for purging urls from caches and CDNs"
+  gem.description   = "An extensible tool for purging urls from caches and CDNs"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ipecache"
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'app_conf', '>= 0.4.0'
+  gem.add_runtime_dependency 'choice', '>= 0.1.6'
+  gem.add_runtime_dependency 'faraday_middleware', '>= 0.9.0'
+  gem.add_runtime_dependency 'savon', '>= 2.1.0'
+end

data/lib/ipecache.rb

@@ -0,0 +1,3 @@
+module Ipecache
+  require 'ipecache/plugins'
+end

data/lib/ipecache/plugins.rb

@@ -0,0 +1,22 @@
+module Ipecache
+  module Plugins
+    # Load each of the drop-in plugins
+    Dir[File.expand_path('../plugins/**/*.rb', __FILE__)].each { |f| require f }
+
+    def self.run(options = {})
+      hook = options[:hook].to_sym
+
+      klasses.each do |klass|
+        plugin = klass.new(options)
+        plugin.send(hook) if plugin.respond_to?(hook) && plugin.enabled?
+      end
+    end
+
+    # Get and return a list of all subclasses (plugins) that are not the base plugin
+    def self.klasses
+      @@klasses ||= self.constants.collect do |c|
+        self.const_get(c) if self.const_get(c).is_a?(Class) && self.const_get(c) != Ipecache::Plugins::Plugin
+      end.compact
+    end
+  end
+end

data/lib/ipecache/plugins/akamai.rb

@@ -0,0 +1,65 @@
+require 'ipecache/plugins/plugin'
+
+module Ipecache
+  module Plugins
+    class Akamai < Plugin
+      name :akamai
+      hooks :cdn_purge
+
+      def perform
+        safe_require 'savon'
+
+        username = config.username
+        password = config.password
+
+        if username.nil?
+          plugin_puts("Akamai username not specified, Exiting...")
+          exit 1
+        end
+
+        if password.nil?
+          plugin_puts("Akamai password key not specified, Exiting...")
+          exit 1
+        end
+
+        puts ""
+        plugin_puts "Beginning URL Purge from Akamai..."
+
+        urls.each do |u|
+          url = u.chomp
+          plugin_puts ("Purging #{url}")
+
+          savon_client = Savon.client({log_level: :info, log: false, convert_request_keys_to: :none,  wsdl: 'https://ccuapi.akamai.com/ccuapi-axis.wsdl'})
+          response = savon_client.call(:purge_request, xml: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+                                                             <soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
+                                                                  xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\"
+                                                                  xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
+                                                                  soap:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\"
+                                                                  xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">
+                                                                  <soap:Body>
+                                                                      <purgeRequest xmlns=\"http://ccuapi.akamai.com/purge\">
+                                                                          <name xsi:type=\"xsd:string\">#{username}</name>
+                                                                          <pwd xsi:type=\"xsd:string\">#{password}</pwd>
+                                                                          <network xsi:type=\"xsd:string\"></network>
+                                                                          <opt soapenc:arrayType=\"xsd:string[2]\" xsi:type=\"soapenc:Array\">
+                                                                              <item xsi:type=\"xsd:string\">type=arl</item>
+                                                                              <item xsi:type=\"xsd:string\">action=remove</item>
+                                                                          </opt>'
+                                                                          <uri soapenc:arrayType=\"xsd:string[1]\" xsi:type=\"soapenc:Array\">
+                                                                            <item xsi:type=\"xsd:string\">#{url}</item>
+                                                                          </uri>
+                                                                      </purgeRequest>
+                                                                  </soap:Body>
+                                                              </soap:Envelope>")
+          response_hash = response.to_hash
+          if response_hash[:purge_request_response][:return][:result_msg] != "Success."
+            plugin_puts "An Error occured: #{response_hash[:purge_request_response][:return][:result_msg]}"
+            exit 1
+          else
+            plugin_puts "Purge successful!"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ipecache/plugins/ats_chef.rb

@@ -0,0 +1,61 @@
+require 'ipecache/plugins/plugin'
+
+module Ipecache
+  module Plugins
+    class ATSChef < Plugin
+      name :atschef
+      hooks :proxy_purge
+
+      def perform
+        safe_require 'chef'
+        safe_require 'uri'
+
+        knife_file = config.knife_config || ""
+        chef_role = config.chef_role
+
+        if knife_file.empty?
+          plugin_puts "No knife config file specified. Exiting..."
+          exit 1
+        elsif File.exists?(knife_file)
+          Chef::Config.from_file(knife_file)
+          rest_api = Chef::REST.new(Chef::Config[:chef_server_url])
+        else
+          plugin_puts "Knife config file #{knife_file} doesn't exist."
+          exit 1
+        end
+
+        if !chef_role
+          plugin_puts "Chef role not specified, Exiting..."
+          exit 1
+        end
+
+        puts ""
+        plugin_puts "Beginning URL Purge from ATS..."
+        plugin_puts "Finding ATS Servers..."
+        nodes_ats_fqdns = []
+        nodes_ats = rest_api.get_rest("/search/node?q=role:#{chef_role}" )
+        nodes_ats["rows"].each do |n|
+          nodes_ats_fqdns <<  n.fqdn unless n.nil?
+        end
+
+        urls.each do |u|
+          url = u.chomp
+          plugin_puts ("Purging #{url}")
+          nodes_ats_fqdns.each do |ats|
+            hostname = URI.parse(url).host
+            path = URI.parse(url).path
+            result = `ssh #{ats} 'curl -X PURGE -s -o /dev/null -w \"%{http_code}\" --header \"Host: #{hostname}\" \"http://localhost#{path}\"'`
+            if result.include?("200")
+              plugin_puts "--Purged from #{ats} sucessfully"
+            elsif result.include?("404")
+              plugin_puts "--Purge from #{ats} not needed, asset not found"
+            else
+              plugin_puts "--Purge from #{ats} failed"
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ipecache/plugins/edgecast.rb

@@ -0,0 +1,59 @@
+require 'ipecache/plugins/plugin'
+
+module Ipecache
+  module Plugins
+    class Edgecast < Plugin
+      name :edgecast
+      hooks :cdn_purge
+
+      def perform
+        safe_require 'uri'
+        safe_require 'faraday_middleware'
+        safe_require 'json'
+
+        account_id = config.account_id
+        api_key = config.api_key
+
+        if account_id.nil?
+          plugin_puts("Edgecast account id not specified, Exiting...")
+          exit 1
+        end
+
+        if api_key.nil?
+          plugin_puts("Edgecast API key not specified, Exiting...")
+          exit 1
+        end
+
+        puts ""
+        plugin_puts "Beginning URL Purge from Edgecast..."
+
+        urls.each do |u|
+          url = u.chomp
+          plugin_puts ("Purging #{url}")
+
+          connection = Faraday::Connection.new(
+              {:url => "https://api.edgecast.com",
+              :headers => { :accept =>  'application/json',
+                            :content_type =>  'application/json',
+                            :user_agent => 'Ipecache',
+                            :authorization => "TOK:#{api_key}"},
+              :ssl => { :verify => true }
+              }) do |builder|
+            builder.request  :json
+            builder.adapter Faraday.default_adapter
+          end
+
+          response = connection.put("/v2/mcc/customers/#{account_id}/edge/purge",{ :MediaPath => url, :MediaType => 8})
+
+          if response.status != 200
+            plugin_puts "Response Code: #{response.status}"
+            plugin_puts response.body
+            exit 1
+          else
+            plugin_puts "Purge successful!"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ipecache/plugins/fastly.rb

@@ -0,0 +1,60 @@
+require 'ipecache/plugins/plugin'
+require 'net/http'
+
+module Ipecache
+  module Plugins
+    class Fastly < Plugin
+      name :fastly
+      hooks :cdn_purge
+
+      def perform
+        safe_require 'uri'
+
+        api_key = config.api_key
+
+        if api_key.nil?
+          plugin_puts("Fastly API key not specified, Exiting...")
+          exit 1
+        end
+
+        puts ""
+        plugin_puts "Beginning URL Purge from Fastly..."
+
+        urls.each do |u|
+          url = u.chomp
+          plugin_puts ("Purging #{url}")
+          hostname = URI.parse(url).host
+          path = URI.parse(url).path
+
+          http = Net::HTTP.new("api.fastly.com", "443")
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+          request = Net::HTTP::Purge.new(path)
+          request.add_field("X-Forwarded-For", "0.0.0.0")
+          request.add_field("Accept", "application/json")
+          request.add_field("User-Agent", "Ipecache")
+          request.add_field("Content-Type", "application/x-www-form-urlencoded")
+          request.add_field("X-Fastly-Key", api_key)
+          request.add_field("Host", hostname)
+
+          response = http.request(request)
+
+          if response.code.to_i != 200
+            plugin_puts "Response Code: #{response.code}"
+            plugin_puts response.body
+            exit 1
+          else
+            plugin_puts "Purge successful!"
+          end
+        end
+      end
+    end
+  end
+end
+
+class Net::HTTP::Purge < Net::HTTPRequest
+  METHOD = 'PURGE'
+  REQUEST_HAS_BODY = false
+  RESPONSE_HAS_BODY = true
+end

data/lib/ipecache/plugins/plugin.rb

@@ -0,0 +1,66 @@
+module Ipecache
+  module Plugins
+    class Plugin
+      # This is the name of the plugin. It must correspond to the name in the yaml configuration
+      # file in order to load this plugin. If an attribute is passed in, the name is set to that
+      # given value. Otherwise, the name is returned.
+      def self.name(name = nil)
+        if name.nil?
+          class_variable_get(:@@name)
+        else
+          class_variable_set(:@@name, name)
+        end
+      end
+
+      # This is a convenience method for defining multiple hooks in a single call.
+      def self.hooks(*the_hooks)
+        [the_hooks].flatten.each{ |the_hook| hook(the_hook) }
+      end
+
+      # When defining a hook, we define a method on the instance that corresponds to that
+      # hook. That will be fired when the hook is fired.
+      def self.hook(the_hook)
+        self.send(:define_method, the_hook.to_sym) do
+          perform
+        end
+      end
+
+      def initialize(options = {})
+        @options = {
+            :payload => {}
+        }.merge(options)
+      end
+
+      def enabled?
+        !(config.nil? || config.enabled == false)
+      end
+
+      def urls
+        @options[:urls]
+      end
+
+      def name
+        self.class.to_s
+      end
+
+      def plugin_puts(message)
+        puts "#{name}: #{message}"
+      end
+
+      private
+      def config
+        @options[:config].plugins.send(self.class.name.to_sym) unless @options[:config].nil? || @options[:config].plugins.nil?
+      end
+
+      # Wrapper method around require that attempts to include the associated file. If it does not exist
+      # or cannot be loaded, an nice error is produced instead of blowing up.
+      def safe_require(file)
+        begin
+          require file
+        rescue LoadError
+          raise "You are using a plugin for ipecache that requires #{file}, but you have not installed it. Please either run \"gem install #{file}\", add #{file} to your Gemfile or remove the plugin from your configuration."
+        end
+      end
+    end
+  end
+end

data/lib/ipecache/runner.rb

@@ -0,0 +1,44 @@
+require 'app_conf'
+require 'json'
+
+require 'ipecache/plugins'
+
+module Ipecache
+  module Runner
+    module ClassMethods; end
+
+    module InstanceMethods
+      def ipecache_config
+        return @ipecache_config unless @ipecache_config.nil?
+
+        @ipecache_config = AppConf.new
+        load_paths = [ File.expand_path('config/ipecache-config.yml'), '/etc/ipecache-config.yml', File.expand_path('~/.ipecache/ipecache-config.yml') ]
+        load_paths.each do |load_path|
+          if File.exists?(load_path)
+            @ipecache_config.load(load_path)
+          end
+        end
+
+        @ipecache_config
+      end
+
+      def run_plugins(hook)
+        urls = @urls
+        Ipecache::Plugins.run(
+          :config => ipecache_config,
+          :hook => hook.to_sym,
+          :urls => urls
+        )
+      end
+
+      def pretty_print_json(json)
+        JSON.pretty_generate(json)
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend(ClassMethods)
+      receiver.send(:include, InstanceMethods)
+    end
+  end
+end

data/plugins/ATSChef.md

@@ -0,0 +1,34 @@
+ATSChef
+========
+Queries chef for nodes in the specified role and purges the URL list from each server
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'chef'
+```
+
+Hooks
+-----
+- `proxy_purge`
+
+Configuration
+-------------
+```yaml
+plugins:
+  atschef:
+    knife_config: /my/.chef/knife.rb
+    chef_role: ATSRole
+```
+
+#### knife_config
+This is the knife.rb that ipecache can use to search against your Chef server
+
+- Type: `String`
+
+#### chef_role
+This is the chef role which your ATS servers live in
+
+- Type: `String`

data/plugins/Akamai.md

@@ -0,0 +1,26 @@
+Akamai
+========
+Purges URLS from the Akamai CDN using the Content Control Utility API
+
+Hooks
+-----
+- `cdn_purge`
+
+Configuration
+-------------
+```yaml
+plugins:
+  akamai:
+    username: foo
+    password: bar
+```
+
+#### username
+This is the username of the Akamai account you want to use
+
+- Type: `String`
+
+#### password
+This is the username of the Akamai account you want to use
+
+- Type: `String`

data/plugins/Edgecast.md

@@ -0,0 +1,26 @@
+Edgecast
+========
+Purges URLS from the Edgecast CDN - please note this currently only works with HTTP Small objects.
+
+Hooks
+-----
+- `cdn_purge`
+
+Configuration
+-------------
+```yaml
+plugins:
+  edgecast:
+    account_id: 1ABC
+    api_key: aaaa-aaaaaa-aaaaaa-aaaaa
+```
+
+#### account_id
+This is your Edgecast account number, found at the top of the Edgecast admin interface
+
+- Type: `String`
+
+#### api_key
+This is your Edgecast API key
+
+- Type: `String`

data/plugins/Fastly.md

@@ -0,0 +1,20 @@
+Fastly
+========
+Purges URLS from the Fastly CDN
+
+Hooks
+-----
+- `cdn_purge`
+
+Configuration
+-------------
+```yaml
+plugins:
+  fastly:
+    api_key: ab123ab123ab123ab123ab123ab123
+```
+
+#### api_key
+This is your fastly API key
+
+- Type: `String`

data/plugins/README.md

@@ -0,0 +1,63 @@
+Plugins Directory
+=================
+This folder contains relevant documentation for each KnifeSpork plugin. For more information, usage, and options for an particular plugin, click on the assoicated markdown file in the tree above.
+
+Creating a Plugin
+-----------------
+To create a plugin, start with the following basic boiler template:
+
+```ruby
+require 'ipecache/plugins/plugin'
+
+module Ipecache
+  module Plugins
+    class MyPlugin < Plugin
+      name :my_plugin
+      hooks :my_hooks
+
+      def perform
+        # your plugin code here
+      end
+    end
+  end
+end
+```
+
+**Don't forget to update the class name and the `name` at the very top of the class!**
+
+Hooks
+-----
+
+Currently, the only hooks called by the ipecache binary are "proxy_purge" (for plugins for "local" proxy servers) and "cdn_purge" (for CDN plugins). These hooks determine whether or not your plugin will be called when the -c and -p options are passed to the ipecache binary.
+
+Helpers
+-------
+The following "helpers" or "methods" are exposed:
+
+#### safe_require
+This method allows you to safely require a gem. This is helpful when your plugin requires an external plugin. It will output a nice error message if the gem cannot be loaded and stop executing.
+
+#### urls
+This method gives you the list of URLS to be purged
+
+#### plugin_puts
+This method prints strings prefixed by the class name of your plugin, for clarity of output
+
+#### config
+This method returns the config associated with the current plugin. For example, if a `spork-config.yml` file looked like this:
+
+```yaml
+plugins:
+  my_plugin:
+    option_1: my_value
+    option_2: other_value
+```
+
+then
+
+```text
+config.option_1   #=> 'my_value'
+config.option_2   #=> 'other_value'
+```
+
+This uses `app_conf`, so you access the keys as methods, not `[]`.

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: ipecache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Cowie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: app_conf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: An extensible tool for purging urls from caches and CDNs
+email: jonlives@gmail.com
+executables:
+- ipecache
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/ipecache
+- ipecache.gemspec
+- lib/ipecache.rb
+- lib/ipecache/plugins.rb
+- lib/ipecache/plugins/akamai.rb
+- lib/ipecache/plugins/ats_chef.rb
+- lib/ipecache/plugins/edgecast.rb
+- lib/ipecache/plugins/fastly.rb
+- lib/ipecache/plugins/plugin.rb
+- lib/ipecache/runner.rb
+- plugins/ATSChef.md
+- plugins/Akamai.md
+- plugins/Edgecast.md
+- plugins/Fastly.md
+- plugins/README.md
+homepage: https://github.com/jonlives/ipecache
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An extensible tool for purging urls from caches and CDNs
+test_files: []
+has_rdoc: