refactored http purge again for consistent interface, improved examples

Author: justquick

README.rst

@@ -35,7 +35,10 @@ across multiple Varnish instances. Here are the features of this python module
 Example::
 
   manager = VarnishManager( ('server1:6082', 'server2:6082') )
-  manager.run('purge.url', '^/$')
+  manager.run('ping')
+  manager.run('ban.url ^/secret/$')
+  manager.run('ban.list')
+  manager.run('purge.url', 'http://mydomain.com/articles/.*')
   manager.close()
 
 Testing::

runtests.py

@@ -16,8 +16,9 @@ def test_ping(self):
         self.assert_(map(lambda x: isinstance(x, float), (True,True)))
 
     def test_purge(self):
-        self.assertEqual(self.manager.purge_url(
-            'http://%s/myrandomurl/.*' % WEB_ADDR).status, 200)
+        resp = self.manager.run(
+            'purge.url', 'http://%s/myrandomurl/.*' % WEB_ADDR)[0][0]
+        self.assertEqual(resp.status, 200)
 
     def test_ban(self):
         regex = '^/banned/*'

varnish.py

@@ -43,6 +43,20 @@
     format = '%(asctime)s %(levelname)s %(message)s',
 )
 
+def http_purge_url(url):
+    """
+    Do an HTTP PURGE of the given asset.
+    The URL is run through urlparse and must point to the varnish instance not the varnishadm
+    """
+    url = urlparse(url)
+    connection = HTTPConnection(url.hostname, url.port or 80)
+    connection.request('PURGE', '%s?%s' % (url.path or '/', url.query), '',
+                      {'Host': url.hostname})
+    response = connection.getresponse()
+    if response.status != 200:
+        logging.error('Purge failed with status: %s' % response.status)
+    return response
+
 class VarnishHandler(Telnet):
     def __init__(self, host_port_timeout, secret=None, **kwargs):
         if isinstance(host_port_timeout, basestring):
@@ -240,6 +254,11 @@ def ban_list(self):
         """
         return self.fetch('ban.list')[1]
 
+    def purge_url(self, url):
+        """
+        Wrapper for http_purge_url
+        """
+        return http_purge_url(url)
 
 
 class ThreadedRunner(Thread):
@@ -299,16 +318,4 @@ def close(self):
         self.run('close', threaded=True)
         self.servers = ()
 
-    def purge_url(self, url):
-        """
-        Do an HTTP PURGE of the given asset.
-        The URL is run through urlparse and must point to the varnish instance not the varnishadm
-        """
-        url = urlparse(url)
-        connection = HTTPConnection(url.hostname, url.port or 80)
-        connection.request('PURGE', '%s?%s' % (url.path or '/', url.query), '',
-                          {'Host': url.hostname})
-        response = connection.getresponse()
-        if response.status != 200:
-            logging.error('Purge failed with status: %s' % response.status)
-        return response
+