cdnetworks-client 0.0.7 → 1.0.0

data/README.md

@@ -1,8 +1,9 @@
 # Cdnetworks Client
 
-The Cdnetworks Client is a simple wrapper for two [Cdnetworks](http://www.cdnetworks.com/) APIs
+The Cdnetworks Client is a simple wrapper for three [Cdnetworks](http://www.cdnetworks.com/) APIs
 * Config Open API v1.0
-* Cache Purge Open API v2.0
+* Cache Purge Open API v2.0 (older cache flushing API)
+* Cache Flush Open API v2.3.2 (most current cache flushing API)
 
 This gem allows a user to call methods from either of these APIs using the same syntax.
 
@@ -74,6 +75,18 @@ You can also add in parameters
 </pre>
 
 ## Purging a cache
+
+### If you are using Cache Flush Open API v2.3.2
+
+<pre>
+  cdn.do_purge(:pad => "cdn.example.com", :type => "all")
+</pre>
+
+<pre>
+  cdn.do_purge(:pad => "cdn.example.com", :path => ["images/one.jpg", "images/two.jpg"])
+</pre>
+
+### If you are using Cache Purge Open API v2.0
 <pre>
   cdn.execute_cache_purge(:purgeUriList => "cdn.example.com")
 </pre>
@@ -82,7 +95,19 @@ You can also add in parameters
   cdn.execute_cache_purge(:purgeUriList => ["cdn.example.com", "cdn.foo.com"])
 </pre>
 
+## Getting the status of a cache purge
+<pre>
+  cdn.status(:pid => 1234)
+</pre>
+
 ## Listing all PAD domain names
+
+### If you are using Cache Flush Open API v2.3.2
+<pre>
+  cdn.pad_list
+</pre>
+
+### If you are using Cache Purge Open API v2.0
 <pre>
   cdn.get_cache_domain_list
 </pre>

data/lib/cdnetworks-client/cache_flush_open_api.rb

@@ -0,0 +1,25 @@
+module CacheFlushOpenApi
+
+  def do_purge(options={})
+    call(cache_flush_path("doPurge"),add_flush_credentials(options))
+  end
+
+  def pad_list(options={})
+    call(cache_flush_path("padList"),add_flush_credentials(options))
+  end
+
+  def status(options={})
+    call(cache_flush_path("status"),add_flush_credentials(options))
+  end
+
+  def cache_flush_path(command)
+    "/purge/rest/#{command}"
+  end
+
+  def add_flush_credentials(options)
+    options[:user]     = @user
+    options[:pass]     = @password
+
+    options
+  end
+end

data/lib/cdnetworks-client/version.rb

@@ -1,5 +1,5 @@
 module Cdnetworks
   module Client
-    VERSION = "0.0.7"
+    VERSION = "1.0.0"
   end
 end

data/lib/cdnetworks-client.rb

@@ -1,10 +1,12 @@
 require "cdnetworks-client/version"
 require "cdnetworks-client/cache_purge_api"
 require "cdnetworks-client/config_open_api"
+require "cdnetworks-client/cache_flush_open_api"
 
 class CdnetworksClient
   include ConfigOpenApi
   include CachePurgeApi
+  include CacheFlushOpenApi
 
 
   def initialize(credentials={})
@@ -24,7 +26,7 @@ class CdnetworksClient
       response = http.request(compose_request(path,options))
       response_hash = { code: response.code, body: response.body }
     rescue StandardError=>e
-      puts "An error has occurred connecting to the CDNetworks API (#{e})"
+      "An error has occurred connecting to the CDNetworks API (#{e})"
     end
   end
 

data/spec/lib/cdnetworks-client/cdnetworks_client_spec.rb

@@ -137,65 +137,151 @@ describe CdnetworksClient do
     end
   end
 
-  context "purging a cache" do
-    before(:each) do
-      stub_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
-      to_return(:status => 200, :body => "", :headers => {})
-    end
+  context "with Cache Purge Open API v2.0" do
+    context "purging a cache" do
+      before(:each) do
+        stub_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        to_return(:status => 200, :body => "", :headers => {})
+      end
 
-    it "calls the purge method of the cdnetworks api" do
-      @cdn_api.execute_cache_purge
+      it "calls the purge method of the cdnetworks api" do
+        @cdn_api.execute_cache_purge
 
-      a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
-      with(:body    => 'userId=user%40user.com&password=secret',
-           :headers => {
-                         'Accept'      =>'*/*',
-                         'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
-    end
+        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        with(:body    => 'userId=user%40user.com&password=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
 
-    it "includes the options passed as a hash" do
-      @cdn_api.execute_cache_purge(:purgeUriList => "cdn.example.com")
+      it "includes the options passed as a hash" do
+        @cdn_api.execute_cache_purge(:purgeUriList => "cdn.example.com")
 
-      a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
-      with(:body    => 'purgeUriList=cdn.example.com&userId=user%40user.com&password=secret',
-           :headers => {
-                         'Accept'      =>'*/*',
-                         'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
+        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        with(:body    => 'purgeUriList=cdn.example.com&userId=user%40user.com&password=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
+
+      it "handles options passed as an array" do
+        @cdn_api.execute_cache_purge(:purgeUriList => ["cdn.example.com", "pad.foo.com"])
+
+        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
+        with(:body    => 'purgeUriList=cdn.example.com&purgeUriList=pad.foo.com&userId=user%40user.com&password=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
     end
 
-    it "handles options passed as an array" do
-      @cdn_api.execute_cache_purge(:purgeUriList => ["cdn.example.com", "pad.foo.com"])
+    context "getting a cache domain list" do
+      before(:each) do
+        stub_request(:post, "https://openapi.us.cdnetworks.com/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
+          to_return(:status => 200, :body => "", :headers => {})
+      end
 
-      a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/executeCachePurge").
-      with(:body    => 'purgeUriList=cdn.example.com&purgeUriList=pad.foo.com&userId=user%40user.com&password=secret',
-           :headers => {
-                         'Accept'      =>'*/*',
-                         'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
+      it "calls the cache domain list method of the cdnetworks api" do
+        @cdn_api.get_cache_domain_list
+
+        a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
+        with(:body    => 'userId=user%40user.com&password=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
     end
   end
 
-  context "getting a cache domain list" do
-    before(:each) do
-	stub_request(:post, "https://openapi.us.cdnetworks.com/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
-        to_return(:status => 200, :body => "", :headers => {})
+  context "with Cache Flush Open API v2.3.2" do
+    context "purging a cache" do
+      before(:each) do
+        stub_request(:post, "#{@url}/purge/rest/doPurge").
+          to_return(:status => 200, :body => "", :headers => {})
+      end
+
+      it "calls the purge method" do
+        @cdn_api.do_purge
+
+        a_request(:post, "#{@url}/purge/rest/doPurge").
+        with(:body    => 'user=user%40user.com&pass=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
+
+      it "handles options passed as a hash" do
+        @cdn_api.do_purge(:pad => "cdn.example.com", :type => "all")
+
+        a_request(:post, "#{@url}/purge/rest/doPurge").
+        with(:body    => 'pad=cdn.example.com&type=all&user=user%40user.com&pass=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
+
+      it "handles options passed as an array" do
+        @cdn_api.do_purge(:path => ["/images/one.jpg", "/images/two.jpg"])
+        a_request(:post, "#{@url}/purge/rest/doPurge").
+        with(:body    => 'path=%2Fimages%2Fone.jpg&path=%2Fimages%2Ftwo.jpg&user=user%40user.com&pass=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
     end
 
-    it "calls the cache domain list method of the cdnetworks api" do
-      @cdn_api.get_cache_domain_list
+    context "getting a list of PADs" do
+      it "calls the list method" do
+        @cdn_api.pad_list
 
-      a_request(:post, "#{@url}/OpenAPI/services/CachePurgeAPI/getCacheDomainList").
-      with(:body    => 'userId=user%40user.com&password=secret',
-           :headers => {
-                         'Accept'      =>'*/*',
-                         'Content-Type'=>'application/x-www-form-urlencoded',
-                         'User-Agent'  =>'Ruby'}).
-      should have_been_made
+        a_request(:post, "#{@url}/purge/rest/padList").
+        with(:body    => 'user=user%40user.com&pass=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
+    end
+
+    context "get the status of a purge" do
+      it "calls the status method" do
+        @cdn_api.status
+
+        a_request(:post, "#{@url}/purge/rest/status").
+        with(:body    => 'user=user%40user.com&pass=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
+
+      it "handles options passsed as a hash" do
+        @cdn_api.status(pid: 1234)
+
+        a_request(:post, "#{@url}/purge/rest/status").
+        with(:body    => 'pid=1234&user=user%40user.com&pass=secret',
+             :headers => {
+                           'Accept'      =>'*/*',
+                           'Content-Type'=>'application/x-www-form-urlencoded',
+                           'User-Agent'  =>'Ruby'}).
+        should have_been_made
+      end
     end
   end
 
@@ -252,7 +338,9 @@ describe CdnetworksClient do
     end
 
     it "returns an error" do
-      @cdn_api.list.should raise_error
+      error_result = @cdn_api.list
+      error_result.should include("An error has occurred")
+      error_result.should include("execution expired")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdnetworks-client
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,6 +59,7 @@ files:
 - Rakefile
 - cdnetworks-client.gemspec
 - lib/cdnetworks-client.rb
+- lib/cdnetworks-client/cache_flush_open_api.rb
 - lib/cdnetworks-client/cache_purge_api.rb
 - lib/cdnetworks-client/config_open_api.rb
 - lib/cdnetworks-client/version.rb