ipecache 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTBjYjQ0NmZiMWI1NTllNjdhYTNkM2YzN2JkNTBjNzc5MjliODE1NQ==
+    ZWYxNWE2YWQwNjExY2E0NWUzMzk3ZTAwMDJmYjEzYjk4Nzc2OWY4Nw==
   data.tar.gz: !binary |-
-    OGFkY2RiMmZiOTcwZDA4OGJiZmQ3MDhhZDM0YzhhODA1ZDgyYTkwZg==
+    MzJiMTJiZGMxMWRjNzQxZGEzY2QxYWRjM2U5M2M2Y2RhOWI5ZGNmNw==
 SHA512:
   metadata.gz: !binary |-
-    NDZiMGM4NjA3ZGUyYzViNzJkNTc4YmZjOWU1OWYxNzEyMzcxNzYxZGU3YTQx
-    NjljNzMxZGUyZWM4NjJmYzgwOGQ5MTMwNTdiMTFkYTE2Y2UwNmYwNzdjZTY1
-    YWRlM2Q2MmU1NGE0MjM3NmQ3MGU4OGE5NTYzOGJhNjMxYTUwNjA=
+    OTdjZjdlMTdhMjVmZDZkOTNlZjBhNzdkY2JjY2UwYjgzY2MyY2I0MDk2ODZl
+    NTc5OTFhMDgwMmNiZjdhMzljZGMzOWQ0NDBhMjg3NzcyZDA3YWJjMTIxY2Q5
+    MTdlMmY3Zjc1NGQzNWVjYWNkMWNkNTFiM2JhNDRkZjU4M2NjMTc=
   data.tar.gz: !binary |-
-    YTQ3OGFiNDJkZmE2YWM0YzNmZTNmNmExOTRlODA3MzNjOTQ3N2VjOTFjNmVj
-    ZTAwMjljN2EwYjdlN2UyYmQ3ZGRmMDIxNWJiOGJiMzU0ZWEzZmFiMzMxNTRi
-    NzY5MTRhYWY5ZWUyODQ4NTA1ZDk2YzYyYjIyYzNlMmU1NzZmYTk=
+    ZjFkODA2YTRjZjMwNDk2NTRhN2E1NDA3YWM4ZGEyNTAxZTg5YWRhZjJiZmM0
+    YzMzOTgxZWNhYmQ0MGZiYWE2MzE2ZGE5ZjY1YzM3MzNlNmJiMzgyMmRkOGNi
+    NTkxYTEwNGRmZGQxN2Q4ZWQ4ZWM5MTBjNTVkYzNmZTAyMGUxZTI=

data/CHANGELOG.md

@@ -1,7 +1,23 @@
+## 0.0.6 (April 28, 2014)
+
+Features:
+
+    - Cloudflare plugin (Thanks to https://github.com/adedommelin)
+    - Add quiet mode  (Thanks to https://github.com/nespresso)
+    - Add -n short option to --nofail (Thanks to https://github.com/nespresso)
+
+Bugfixes:
+
+    - Fix plugin_puts_error to print URL (Thanks to https://github.com/nespresso)
+
 ## 0.0.5 (April 25, 2014)
 
-Switched Akamai plugin to use new CCUAPI (Thanks to https://github.com/adedommelin)
+Features:
+
+    - Switched Akamai plugin to use new CCUAPI (Thanks to https://github.com/adedommelin)
 
 ## 0.0.1 (March 20, 2013)
 
-Initial version.
+Features:
+
+    - Initial version.

data/Gemfile.lock

@@ -1,21 +1,44 @@
 PATH
   remote: .
   specs:
-    ipecache (0.0.5)
+    ipecache (0.0.4)
       app_conf (>= 0.4.0)
       choice (>= 0.1.6)
       faraday_middleware (>= 0.9.0)
+      savon (>= 2.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    app_conf (0.4.1)
+    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.8)
-      multipart-post (~> 1.2.0)
+    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.9)
+    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

data/README.md

@@ -45,6 +45,9 @@ plugins:
   akamai:
     username: myusername
     password: mypassword
+  cloudflare:
+    login: foo@bar.com
+    api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 ```
 
 #### atschef
@@ -59,6 +62,9 @@ For more information on how to configure the Edgecast CDN plugin, please read th
 #### Akamai
 For more information on how to configure the Akamai plugin, please read the [plugins/Akamai.md](plugins/Akamai.md) file.
 
+#### CloudFlare
+For more information on how to configure the CloudFlare plugin, please read the [plugins/CloudFlare.md](plugins/CloudFlare.md) file.
+
 
 
 Ipecache Usage
@@ -67,7 +73,7 @@ The main component of Ipecache, and the program which initialises and calls all
 
 #### Usage
 ```bash
-ipecache [-f -u -c -p -l --status]
+ipecache [-f -u -c -p -l -q --status]
 ```
 
 * Mandatory Parameters (you must specify one or the other)
@@ -79,7 +85,8 @@ ipecache [-f -u -c -p -l --status]
     * -c: Indicates that only CDN plugins should be run
     * -p: Indicates that only local proxy plugins should be run.
     * -l: Specify a file to log errors to
-    * --nofail: Do not quit on error, continue purging
+    * -n, --nofail: Do not quit on error, continue purging
+    * -q, --quiet: Suppress all console output
 
 
 #### Example (Checking plugin status)
@@ -179,4 +186,4 @@ $>  ipecache -f ~/urlfile
    Ipecache::Plugins::Fastly: Purge successful!
 
    All done!
-```
+```

data/bin/ipecache

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# ipecache - A command line memcached traffic analyzer
+# ipecache - Extensible tool for purging URLs from Caches and CDNs.
 #
 # Author:: Jon Cowie (<jcowie@etsy.com>)
 
@@ -48,9 +48,20 @@ Choice.options do
   end
 
   option :continue_on_error, :required => false do
+    short '-n'
      long  '--nofail'
      desc  'Continue on errors instead of exiting'
    end
+
+  option :quiet_mode, :required => false do
+    short '-q'
+    long  '--quiet'
+    desc  'Suppress all console output'
+  end
+end
+
+if Choice.choices[:quiet_mode]
+  @quiet_mode = Choice.choices[:quiet_mode]
 end
 
 if Choice.choices[:status]
@@ -70,7 +81,9 @@ elsif  Choice.choices[:urlfile]
   if File.exists?(urlfile)
     @urls = File.open(urlfile, 'r').readlines
   else
-    puts "Error: #{urlfile} doesn't exist."
+    if !@quiet_mode
+      puts "Error: #{urlfile} doesn't exist."
+    end
     exit 1
   end
 else
@@ -86,18 +99,24 @@ if Choice.choices[:continue_on_error]
 end
 
 if !Choice.choices[:cdnonly]
-  puts ""
-  puts "Running plugins registered for Proxy Purge..."
-  puts ""
+  if !@quiet_mode
+    puts ""
+    puts "Running plugins registered for Proxy Purge..."
+    puts ""
+  end
   run_plugins(:proxy_purge)
 end
 
 if !Choice.choices[:proxyonly]
-  puts ""
-  puts "Running plugins registered for CDN Purge..."
-  puts ""
+  if !@quiet_mode
+    puts ""
+    puts "Running plugins registered for CDN Purge..."
+    puts ""
+  end
   run_plugins(:cdn_purge)
 end
 
-puts ""
-puts "All done!"
+if !@quiet_mode
+  puts ""
+  puts "All done!"
+end

data/ipecache.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'ipecache'
-  gem.version       = '0.0.5'
+  gem.version       = '0.0.6'
   gem.authors       = ["Jon Cowie"]
   gem.email         = 'jonlives@gmail.com'
   gem.homepage      = 'https://github.com/jonlives/ipecache'
@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   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 'public_suffix', '>= 1.4.2'
 end

data/lib/ipecache/plugins/akamai.rb

@@ -23,7 +23,6 @@ module Ipecache
           exit 1
         end
 
-        puts ""
         plugin_puts "Beginning URL Purge from Akamai..."
 
         urls.each do |u|

data/lib/ipecache/plugins/ats_chef.rb

@@ -29,7 +29,6 @@ module Ipecache
           exit 1
         end
 
-        puts ""
         plugin_puts "Beginning URL Purge from ATS..."
         plugin_puts "Finding ATS Servers..."
         nodes_ats_fqdns = []
@@ -58,4 +57,4 @@ module Ipecache
       end
     end
   end
-end
+end

data/lib/ipecache/plugins/cloudflare.rb

@@ -0,0 +1,70 @@
+require 'ipecache/plugins/plugin'
+
+module Ipecache
+  module Plugins
+    class CloudFlare < Plugin
+      name :cloudflare
+      hooks :cdn_purge
+
+      def perform
+        safe_require 'uri'
+        safe_require 'faraday_middleware'
+        safe_require 'json'
+        safe_require 'public_suffix'
+
+        login = config.login
+        api_key = config.api_key
+
+        if login.nil?
+          plugin_puts "CloudFlare login not specified, Exiting..."
+          exit 1
+        end
+
+        if api_key.nil?
+          plugin_puts "CloudFlare API key not specified, Exiting..."
+          exit 1
+        end
+
+        plugin_puts "Beginning URL Purge from CloudFlare..."
+
+        urls.each do |u|
+          url = u.chomp
+          plugin_puts  "Purging #{url}"
+
+          uri = URI.parse(url)
+          zone = PublicSuffix.parse(uri.host).domain
+
+          connection = Faraday::Connection.new(
+              {:url => "https://www.cloudflare.com",
+              :headers => { :accept =>  'application/json',
+                            :user_agent => 'Ipecache'
+                          },
+              :ssl => { :verify => true }
+              }) do |builder|
+            builder.request  :url_encoded
+            builder.adapter Faraday.default_adapter
+          end
+
+          response = connection.get("/api_json.html",
+            { :act    => 'zone_file_purge',
+              :tkn    => api_key,
+              :email  => login,
+              :z      => zone,
+              :url    => url
+            })
+
+          response_json = JSON.parse(response.body)
+          response_result = response_json['result']
+
+          if response_result != 'success'
+            plugin_puts_error(url,"Purge failed!")
+            plugin_puts response.body
+            exit 1 unless continue_on_error
+          else
+            plugin_puts "Purge successful!"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ipecache/plugins/edgecast.rb

@@ -24,7 +24,6 @@ module Ipecache
           exit 1
         end
 
-        puts ""
         plugin_puts "Beginning URL Purge from Edgecast..."
 
         urls.each do |u|
@@ -56,4 +55,4 @@ module Ipecache
       end
     end
   end
-end
+end

data/lib/ipecache/plugins/fastly.rb

@@ -17,7 +17,6 @@ module Ipecache
           exit 1
         end
 
-        puts ""
         plugin_puts "Beginning URL Purge from Fastly..."
 
         urls.each do |u|
@@ -57,4 +56,4 @@ class Net::HTTP::Purge < Net::HTTPRequest
   METHOD = 'PURGE'
   REQUEST_HAS_BODY = false
   RESPONSE_HAS_BODY = true
-end
+end

data/lib/ipecache/plugins/plugin.rb

@@ -21,6 +21,9 @@ module Ipecache
       # hook. That will be fired when the hook is fired.
       def self.hook(the_hook)
         self.send(:define_method, the_hook.to_sym) do
+          if !quiet_mode
+            puts ""
+          end
           perform
         end
       end
@@ -47,19 +50,28 @@ module Ipecache
         @options[:continue_on_error]
       end
 
+      def quiet_mode
+        @options[:quiet_mode]
+      end
+
       def name
         self.class.to_s
       end
 
       def plugin_puts(message)
-        puts "#{name}: #{message}"
+        if !quiet_mode
+          puts "#{name}: #{message}"
+        end
       end
 
       def plugin_puts_error(url,message)
         if log_file
           File.open(log_file, 'a') { |file| file.write("#{Time.now.getutc} #{url} #{name}: #{message}\n") }
         end
-        puts "#{name}: #{message}"
+
+        if !quiet_mode
+          puts "#{url} #{name}: #{message}"
+        end
       end
 
       private

data/lib/ipecache/runner.rb

@@ -26,12 +26,14 @@ module Ipecache
         urls = @urls
         log_file = @log_file
         continue_on_error = @continue_on_error
+        quiet_mode = @quiet_mode
         Ipecache::Plugins.run(
           :config => ipecache_config,
           :hook => hook.to_sym,
           :urls => urls,
           :log_file => log_file,
-          :continue_on_error => continue_on_error
+          :continue_on_error => continue_on_error,
+          :quiet_mode => quiet_mode
         )
       end
 

data/plugins/CloudFlare.md

@@ -0,0 +1,26 @@
+CloudFlare
+==========
+Purge URLs from the CloudFlare CDN.
+
+Hooks
+-----
+- `cdn_purge`
+
+Configuration
+-------------
+```yaml
+plugins:
+  cloudflare:
+    login: foo@bar.com
+    api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+#### login
+This is your standard CloudFlare login.
+
+- Type: `String`
+
+#### api_key
+Associated API Key, available on the "Account" page.
+
+- Type: `String`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipecache
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jon Cowie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: app_conf
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 description: An extensible tool for purging urls from caches and CDNs
 email: jonlives@gmail.com
 executables:
@@ -71,12 +85,14 @@ files:
 - lib/ipecache/plugins.rb
 - lib/ipecache/plugins/akamai.rb
 - lib/ipecache/plugins/ats_chef.rb
+- lib/ipecache/plugins/cloudflare.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/CloudFlare.md
 - plugins/Edgecast.md
 - plugins/Fastly.md
 - plugins/README.md