importing maxcdn, fixes #820

atmos · atmos · commit 89008c71ae2e · 2014-04-25T10:07:45.000-07:00
diff --git a/docs/maxcdn b/docs/maxcdn
@@ -0,0 +1,17 @@
+Purge your MaxCDN Pull Zone
+---------------------------
+
+**Setup Notes**
+
+  1. Get your "Company Alias", "Consumer Key" and "Consumer Secret" from your [MaxCDN Account API Page][account_api_url].
+  2. Get your "Zone ID" from your [MaxCDN Account Pull Zones Overview page][account_pull_zone].
+  3. "Static Only" will only purge your zone if modified files include static files &mdash `css`, `js`, `jpg`, `jpeg`, `gif`, `ico`, `png`, `bmp`, `pict`, `csv`, `doc`, `pdf`, `pls`, `ppt`, `tif`, `tiff`, `eps`, `ejs`, `swf`, `midi`, `mid`, `txt`, `ttf`, `eot`, `woff`, `otf`, `svg`, `svgz`, `webp`, `docx`, `xlsx`, `xls`, `pptx`, `ps`, `rss`, `class`, `jar`.
+  4. Whitelist the Github web hook IP block with MaxCDN. For instructions, see MaxCDN's support page on [How To Whitelsit Your Server IP To Use The API][whitelist_article].
+
+> Github's IPs may change from time to time, if you're having issues, verify that the IP you've whitelisted is still current, by checking the "hook" key at [Github's "meta" API endpoint][meta_endpoint].
+
+[account_api_url]: https://cp.maxcdn.com/account/api
+[account_pull_zone]: https://cp.maxcdn.com/zones/pull
+[whitelist_article]: http://support.maxcdn.com/tutorials/how-to-whitelist-your-server-ip-to-use-the-api/
+[meta_endpoint]: https://api.github.com/meta
+
diff --git a/github-services.gemspec b/github-services.gemspec
@@ -33,6 +33,9 @@ Gem::Specification.new do |spec|
   # Twitter
   spec.add_dependency "oauth",                  "0.4.4"
 
+  # MaxCDN
+  spec.add_dependency "maxcdn",                  "~> 0.1.6"
+
   # Campfire
   spec.add_dependency "tinder",                 "1.8.0.github"
 
diff --git a/lib/services/maxcdn.rb b/lib/services/maxcdn.rb
@@ -0,0 +1,66 @@
+require "maxcdn"
+
+class Service::MaxCDN < Service
+
+  STATIC_EXTENSIONS = [
+    :css, :js, :jpg, :jpeg, :gif, :ico, :png, :bmp,
+    :pict, :csv, :doc, :pdf, :pls, :ppt, :tif, :tiff,
+    :eps, :ejs, :swf, :midi, :mid, :txt, :ttf, :eot,
+    :woff, :otf, :svg, :svgz, :webp, :docx, :xlsx,
+    :xls, :pptx, :ps, :rss, :class, :jar
+  ].freeze
+
+  string        :alias,
+                :key,
+                :secret,
+                :zone_id
+
+  boolean       :static_only
+
+  url           "http://docs.maxcdn.com/"
+  logo_url      "http://www.maxcdn.com/wp-content/themes/maxcdnv4/img/png/maxcdn-colored-logo.png"
+
+  maintained_by :github  => "jmervine",
+                :email   => "joshua@mervine.net",
+                :twitter => "@mervinej"
+
+  supported_by  :web     => "http://support.maxcdn.com/",
+                :email   => "support@maxcdn.com",
+                :twitter => "@MaxCDN"
+
+  def receive_push
+    return unless payload["commits"]
+    return if data["static_only"] and has_static?
+
+    begin
+      maxcdn.purge data["zone_id"]
+    rescue ::MaxCDN::APIException => e
+      raise_config_error(e.message)
+    end
+  end
+
+  def modified_files
+    payload["commits"].map { |commit| commit["modified"] }.flatten!.uniq!
+  end
+
+  def extensions
+    ::Service::MaxCDN::STATIC_EXTENSIONS
+  end
+
+  def has_static?
+    files = modified_files.clone.select! do |file|
+      matched = false
+      extensions.each do |ext|
+        matched = true if /#{ext}/.match(file)
+      end
+      matched
+    end
+
+    (files.size > 0)
+  end
+
+  def maxcdn
+    @maxcdn ||= ::MaxCDN::Client.new(data["alias"], data["key"], data["secret"])
+  end
+end
+
diff --git a/test/maxcdn_test.rb b/test/maxcdn_test.rb
@@ -0,0 +1,102 @@
+require File.expand_path("../helper", __FILE__)
+
+# stub
+require "maxcdn"
+module MaxCDN
+  class Client
+    def initialize *args
+      @purge_calls = 0
+      @fake_error  = false
+    end
+
+    def purge id
+      raise ::MaxCDN::APIException.new("test error") if @fake_error
+
+      @purge_calls += 1
+      return { "code" => "200" }
+    end
+
+    def fake_error
+      @fake_error = true
+    end
+  end
+end
+
+class MaxCDNTest < Service::TestCase
+  def setup
+    @arguments ||= {
+      "alias"       => "foobar_alias",
+      "key"         => "foobar_key",
+      "secret"      => "foobar_secret",
+      "zone_id"     => 123456,
+      "static_only" => false
+    }
+
+    @svc = service(@arguments, dynamic_payload)
+  end
+
+  def test_maxcdn
+    assert @svc.maxcdn
+  end
+
+  def test_extensions
+    assert_includes @svc.extensions, :js
+  end
+
+  def test_has_static?
+    refute @svc.has_static?
+
+    svc = service(@arguments, static_payload)
+    assert svc.has_static?
+  end
+
+  def test_receive_push
+    assert @svc.receive_push
+    assert_equal 1, @svc.maxcdn.instance_variable_get(:@purge_calls)
+
+    @svc.maxcdn.fake_error
+    error = assert_raises ::Service::ConfigurationError do
+      @svc.receive_push
+    end
+
+    assert_match /test error/, error.message
+
+    arguments = @arguments.clone
+    arguments["static_only"] = true
+    svc = service(arguments, static_payload)
+
+    refute svc.receive_push
+  end
+
+  def dynamic_payload
+    unless defined? @dynamic_payload
+      # Default payload is all .rb files and thus, a
+      # non-static payload. However, to be sure (should
+      # something change in the future) I'll ensure it.
+      @dynamic_payload = payload.clone
+      @dynamic_payload["commits"].each_index do |commit|
+        @dynamic_payload["commits"][commit]["modified"].each_index do |file|
+          @dynamic_payload["commits"][commit]["modified"][file].gsub!(/\.[a-z0-9]+$/, ".rb")
+        end
+      end
+    end
+    @dynamic_payload
+  end
+
+  def static_payload
+    unless defined? @static_payload
+      # Creating a static payload, by replacing a single
+      # file in the payload with a static file extension.
+      @static_payload  = payload.clone
+      @static_payload["commits"]
+          .first["modified"]
+          .last
+          .gsub!(/\.[a-z0-9]+$/, ".js")
+    end
+    @static_payload
+  end
+
+  def service(*args)
+    super Service::MaxCDN, *args
+  end
+end
