Add watermark support

.travis.yml

@@ -10,6 +10,7 @@ cache:
 env:
   global:
   - RANDOM_SEED=12345
+  - REGENERATE_IMAGES=true
   - VALIDATE_LINKS=true
 
 install:

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Revision History
 
+## 5.1
+
+- Added `?watermark=<str>` option to include name of supported clients.
+
 ## 5.0
 
 - Removed `/api/magic` route.

Makefile

@@ -107,6 +107,7 @@ doctor:  ## Confirm system dependencies are available
 	echo "GOOGLE_ANALYTICS_TID=local" >> $@
 	echo "#REGENERATE_IMAGES=true" >> $@
 	echo "#VALIDATE_LINKS=true" >> $@
+	echo "WATERMARK_OPTIONS=localhost" >> $@
 
 # PROJECT DEPENDENCIES #########################################################
 

app.json

@@ -22,6 +22,9 @@
     },
     "TWITTER_IMAGE_WIDTH": {
       "required": true
+    },
+    "WATERMARK_OPTIONS": {
+      "required": true
     }
   },
   "addons":[

memegen/__init__.py

@@ -3,7 +3,7 @@
 import sys
 
 __project__ = 'memegen.link'
-__version__ = '5.0'
+__version__ = '5.1'
 
 VERSION = "{} v{}".format(__project__, __version__)
 

memegen/domain/image.py

@@ -12,22 +12,24 @@ class Image(object):
     """JPEG generated by applying text to a template."""
 
     def __init__(self, template, text, root=None,
-                 style=None, font=None, size=None):
+                 style=None, font=None, size=None, watermark=""):
         self.root = root
         self.template = template
         self.style = style
         self.text = text
         self.font = font
         self.width = size.get('width') if size else None
         self.height = size.get('height') if size else None
+        self.watermark = watermark
 
     @property
     def path(self):
         if not self.root:
             return None
 
         base = os.path.join(self.root, self.template.key, self.text.path)
-        custom = [self.style, self.font, self.width, self.height]
+        custom = [self.style, self.font,
+                  self.width, self.height, self.watermark]
 
         if any(custom):
             slug = self.hash(custom)
@@ -48,6 +50,7 @@ def save(self):
             font=self.font.path,
             background=self.template.get_path(self.style),
             width=self.width, height=self.height,
+            watermark=self.watermark,
         )
 
         directory = os.path.dirname(self.path)
@@ -60,11 +63,7 @@ def save(self):
         return path
 
 
-# The following Pillow image functions are based on:
-# https://github.com/danieldiekmeier/memegenerator
-
-
-def _generate(top, bottom, font, background, width, height):
+def _generate(top, bottom, font, background, width, height, watermark):
     """Add text to an image and save it."""
     log.info("Loading background: %s", background)
     background_image = ImageFile.open(background)
@@ -130,6 +129,13 @@ def _generate(top, bottom, font, background, width, height):
     if width and height:
         image = _add_blurred_background(image, background_image, width, height)
 
+    # Add watermark
+    if watermark:
+        draw = ImageDraw.Draw(image)
+        watermark_font = ImageFont.truetype(font, 15)
+        _draw_outlined_text(draw, (3, image.size[1] - 20),
+                            watermark, watermark_font, 15)
+
     return image
 
 

memegen/routes/image.py

@@ -21,6 +21,7 @@
     'share': fields.Bool(missing=False),
     'width': fields.Int(missing=None),
     'height': fields.Int(missing=None),
+    'watermark': fields.Str(missing=None),
 }
 
 
@@ -60,8 +61,9 @@ def get_without_text_jpeg(key):
 
 @blueprint.route("/<key>/<path:path>.jpg", endpoint='get')
 @flaskparser.use_kwargs(OPTIONS)
-def get_with_text(key, path, alt, font, preview, share, **size):
-    options = dict(key=key, path=path, alt=alt, font=font, **size)
+def get_with_text(key, path, alt, font, watermark, preview, share, **size):
+    options = dict(key=key, path=path,
+                   alt=alt, font=font, watermark=watermark, **size)
     if preview:
         options['preview'] = True
     if share:
@@ -79,16 +81,22 @@ def get_with_text(key, path, alt, font, preview, share, **size):
         options.pop('alt')
         return redirect(route('.get', **options))
 
+    if path != text.path:
+        options['path'] = text.path
+        return redirect(route('.get', **options))
+
     if font and not fontfile:
         options.pop('font')
         return redirect(route('.get', **options))
 
-    if path != text.path:
-        options['path'] = text.path
+    if watermark and watermark not in app.config['WATERMARK_OPTIONS']:
+        options.pop('watermark')
         return redirect(route('.get', **options))
 
-    image = app.image_service.create(template, text,
-                                     style=alt, font=fontfile, size=size)
+    image = app.image_service.create(
+        template, text,
+        style=alt, font=fontfile, size=size, watermark=watermark,
+    )
 
     if not preview:
         cache_filtered.add(key=key, path=path, alt=alt, font=font)

memegen/settings.py

@@ -1,5 +1,7 @@
 import os
 
+from . import __project__
+
 
 class Config:
     """Base configuration."""
@@ -28,6 +30,7 @@ class Config:
     REMOTE_TRACKING_URL = os.getenv('REMOTE_TRACKING_URL')
     TWITTER_IMAGE_HEIGHT = os.getenv('TWITTER_IMAGE_HEIGHT', 401)
     TWITTER_IMAGE_WIDTH = os.getenv('TWITTER_IMAGE_WIDTH', 801)
+    WATERMARK_OPTIONS = os.getenv('WATERMARK_OPTIONS', "").split(',')
 
 
 class ProdConfig(Config):
@@ -47,6 +50,8 @@ class TestConfig(Config):
     DEBUG = True
     TESTING = True
 
+    WATERMARK_OPTIONS = ['test']
+
 
 class DevConfig(Config):
     """Development configuration."""
@@ -55,6 +60,8 @@ class DevConfig(Config):
 
     DEBUG = True
 
+    WATERMARK_OPTIONS = ['dev', 'localhost', '127.0.0.1']
+
 
 def get_config(name):
     assert name, "No configuration specified"

tests/test_api_root.py

@@ -16,6 +16,6 @@ def it_returns_links_and_metadata(client):
             'fonts': "http://localhost/api/fonts/",
             'aliases': "http://localhost/api/aliases/",
             'search': "http://localhost/api/search/",
-            'version': "5.0",
+            'version': "5.1",
             'changes': "https://raw.githubusercontent.com/jacebrowning/memegen/master/CHANGELOG.md"
         }

tests/test_images.py

@@ -166,6 +166,28 @@ def it_keeps_size_after_redirect(client):
             expect(load(response, as_json=False)).contains(
                 'height=89')
 
+    def describe_watermark():
+
+        def it_accept_supported_watermark(client):
+            response = client.get("/iw/test.jpg?watermark=test")
+
+            expect(response.status_code) == 200
+            expect(response.mimetype) == 'image/jpeg'
+
+        def it_redirects_with_unsupported_watermark(client):
+            response = client.get("/iw/test.jpg?watermark=unsupported")
+
+            expect(response.status_code) == 302
+            expect(load(response, as_json=False)).contains(
+                '<a href="/iw/test.jpg"')
+
+        def it_keeps_watermark_after_redirect(client):
+            response = client.get("/iw/test 2.jpg?watermark=test")
+
+            expect(response.status_code) == 302
+            expect(load(response, as_json=False)).contains(
+                '<a href="/iw/test_2.jpg?watermark=test"')
+
     def describe_preview():
 
         def it_keeps_flag_after_redirect(client):

tests/test_images_examples.py

@@ -68,3 +68,14 @@ def test_custom_sizes(client):
         ("size-both.jpg", "/fry/hello/world.jpg?width=200&height=300"),
     ]:
         save_image(client, url, name)
+
+
+@pytest.mark.skipif(**unset('REGENERATE_IMAGES'))
+def test_forced_watermark(client):
+    """Create meme with a watermark."""
+    for name, partial in [
+        ("watermark.jpg", "/fry/hello/world.jpg?"),
+        ("watermark-pad-h.jpg", "/fry/hello/world.jpg?width=300&height=200&"),
+        ("watermark-pad-v.jpg", "/fry/hello/world.jpg?width=200&height=300&"),
+    ]:
+        save_image(client, partial + "watermark=test", name)