Add public_base_url option to S3Store

It's useful when used with CDN

Author: dahlia

docs/changes.rst

@@ -8,6 +8,11 @@ To be released.
 
 - Added :mod:`sqlalchemy_imageattach.migration` module for storage migration.
   See also :ref:`migrate-store` guide.
+- Added ``public_base_url`` option to :class:`S3Store
+  <sqlalchemy_imageattach.stores.s3.S3Store>`.  It's useful when used with
+  CDN e.g. CloudFront_.
+
+.. _CloudFront: http://aws.amazon.com/cloudfront/
 
 
 Version 0.8.0

sqlalchemy_imageattach/stores/s3.py

@@ -134,6 +134,12 @@ class S3Store(Store):
     :param prefix: the optional key prefix to logically separate stores
                    with the same bucket.  not used by default
     :type prefix: :class:`basestring`
+    :param public_base_url: an optional url base for public urls.
+                            useful when used with cdn
+    :type public_base_url: :class:`basestring`
+
+    .. versionchanged:: 0.8.1
+       Added ``public_base_url`` parameter.
 
     """
 
@@ -150,16 +156,25 @@ class S3Store(Store):
     #: stores with the same bucket.
     prefix = None
 
+    #: (:class:`basestring`) The optional url base for public urls.
+    public_base_url = None
+
     def __init__(self, bucket, access_key=None, secret_key=None,
-                 max_age=DEFAULT_MAX_AGE, prefix=''):
+                 max_age=DEFAULT_MAX_AGE, prefix='', public_base_url=None):
         self.bucket = bucket
         self.access_key = access_key
         self.secret_key = secret_key
         self.base_url = BASE_URL_FORMAT.format(bucket)
         self.max_age = max_age
         self.prefix = prefix.strip()
         if self.prefix.endswith('/'):
-            self.prefix = self.prfix[:-1]
+            self.prefix = self.prefix.rstrip('/')
+        if public_base_url is None:
+            self.public_base_url = self.base_url
+        elif public_base_url.endswith('/'):
+            self.public_base_url = public_base_url.rstrip('/')
+        else:
+            self.public_base_url = public_base_url
 
     def get_key(self, object_type, object_id, width, height, mimetype):
         key = '{0}/{1}/{2}x{3}{4}'.format(
@@ -171,16 +186,22 @@ def get_key(self, object_type, object_id, width, height, mimetype):
         return key
 
     def get_file(self, *args, **kwargs):
-        url = self.get_url(*args, **kwargs)
+        url = self.get_s3_url(*args, **kwargs)
         request = self.make_request(url)
         return urllib2.urlopen(request)
 
-    def get_url(self, *args, **kwargs):
+    def get_s3_url(self, *args, **kwargs):
         return '{0}/{1}'.format(
             self.base_url,
             self.get_key(*args, **kwargs)
         )
 
+    def get_url(self, *args, **kwargs):
+        return '{0}/{1}'.format(
+            self.public_base_url,
+            self.get_key(*args, **kwargs)
+        )
+
     def make_request(self, url, *args, **kwargs):
         return S3Request(url, *args,
                          bucket=self.bucket,
@@ -219,11 +240,11 @@ def upload_file(self, url, data, content_type, rrs, acl='public-read'):
 
     def put_file(self, file, object_type, object_id, width, height, mimetype,
                  reproducible):
-        url = self.get_url(object_type, object_id, width, height, mimetype)
+        url = self.get_s3_url(object_type, object_id, width, height, mimetype)
         self.upload_file(url, file.read(), mimetype, rrs=reproducible)
 
     def delete_file(self, *args, **kwargs):
-        url = self.get_url(*args, **kwargs)
+        url = self.get_s3_url(*args, **kwargs)
         request = self.make_request(url, method='DELETE')
         urllib2.urlopen(request).read()
 
@@ -311,7 +332,7 @@ def put_file(self, *args, **kwargs):
     def delete_file(self, object_type, object_id, width, height, mimetype):
         args = object_type, object_id, width, height, mimetype
         self.overriding.delete_file(*args)
-        url = self.overriding.get_url(*args)
+        url = self.overriding.get_s3_url(*args)
         self.overriding.upload_file(
             url,
             data=b'',

tests/stores/s3_test.py

@@ -1,4 +1,5 @@
 import functools
+import itertools
 import os.path
 import re
 try:
@@ -75,9 +76,15 @@ def s3_sandbox_store_getter(request):
                              secret_key=secret_key)
 
 
-@mark.parametrize('prefix', ['', 'prefixtest'])
-def test_s3_store(prefix, s3_store_getter):
-    s3 = s3_store_getter(prefix=prefix)
+@mark.parametrize(
+    ('prefix', 'public_base_url'),
+    list(
+        itertools.product(['', 'prefixtest', 'prefixtest/'],
+                          [None, 'http://example.com', 'https://example.com/'])
+    )
+)
+def test_s3_store(prefix, public_base_url, s3_store_getter):
+    s3 = s3_store_getter(prefix=prefix, public_base_url=public_base_url)
     thing_id = uuid.uuid1().int
     image = TestingImage(thing_id=thing_id, width=405, height=640,
                          mimetype='image/jpeg', original=True,
@@ -90,7 +97,11 @@ def test_s3_store(prefix, s3_store_getter):
     with s3.open(image) as actual:
         actual_data = actual.read()
     assert expected_data == actual_data
-    expected_url = s3.get_url('testing', thing_id, 405, 640, 'image/jpeg')
+    key_args = 'testing', thing_id, 405, 640, 'image/jpeg'
+    if public_base_url:
+        expected_url = public_base_url.rstrip('/') + '/' + s3.get_key(*key_args)
+    else:
+        expected_url = s3.get_url(*key_args)
     actual_url = s3.locate(image)
     assert remove_query(expected_url) == remove_query(actual_url)
     if prefix: