Merge pull request #140 from jacebrowning/aliases-route

Add aliases route

memegen/app.py

@@ -92,3 +92,4 @@ def register_blueprints(app):
     app.register_blueprint(routes.overview.blueprint)
     app.register_blueprint(routes.generator.blueprint)
     app.register_blueprint(routes.latest.blueprint)
+    app.register_blueprint(routes.aliases.blueprint)

memegen/routes/__init__.py

@@ -6,3 +6,4 @@
 from . import overview
 from . import generator
 from . import latest
+from . import aliases

memegen/routes/_common.py

@@ -2,16 +2,11 @@
 
 from flask import current_app as app
 from flask import url_for as _url_for
-from webargs import fields
 
 
 GITHUB_BASE = "http://github.com/jacebrowning/memegen/"
 CONTRIBUTING = GITHUB_BASE + "blob/master/CONTRIBUTING.md"
 
-OPTIONS = {
-    'alt': fields.Str(missing=None)  # pylint: disable=no-member
-}
-
 
 def url_for(*args, **kwargs):
     """Unquoted version of Flask's `url_for`."""

memegen/routes/aliases.py

@@ -0,0 +1,32 @@
+from collections import OrderedDict
+
+from flask import Blueprint, current_app as app
+from webargs import fields, flaskparser
+
+from ._common import url_for
+
+
+blueprint = Blueprint('aliases', __name__, url_prefix="/aliases/")
+
+FILTER = {
+    'name': fields.Str(missing="")  # pylint: disable=no-member
+}
+
+
+@blueprint.route("")
+@flaskparser.use_kwargs(FILTER)
+def get(name):
+    """Get a list of all matching aliases."""
+    items = OrderedDict()
+
+    for alias in sorted(app.template_service.aliases(name)):
+        template = app.template_service.find(alias)
+
+        data = OrderedDict()
+        data['styles'] = sorted(template.styles)
+        data['template'] = \
+            url_for('templates.create', key=template.key, _external=True)
+
+        items[alias] = data
+
+    return items

memegen/routes/image.py

@@ -1,14 +1,18 @@
 from flask import Blueprint, redirect, send_file
 from flask import current_app as app, request
-from webargs import flaskparser
+from webargs import fields, flaskparser
 import requests
 
 from .. import domain
 
-from ._common import OPTIONS, url_for
+from ._common import url_for
 
 blueprint = Blueprint('image', __name__, url_prefix="/")
 
+OPTIONS = {
+    'alt': fields.Str(missing=None)  # pylint: disable=no-member
+}
+
 
 @blueprint.route("latest.jpg")
 def get_latest():

memegen/routes/root.py

@@ -28,6 +28,7 @@ def get():
     """Generate memes from templates."""
     data = OrderedDict()
     data['templates'] = url_for('templates.get', _external=True)
+    data['aliases'] = url_for('aliases.get', _external=True)
     data['version'] = __version__
     return data
 

memegen/services/template.py

@@ -36,6 +36,15 @@ def find(self, key):
         # Else, no match
         raise self.exceptions.TemplateNotFound
 
+    def aliases(self, query=""):
+        """Get all aliases with an optional name filter."""
+        names = []
+        for template in self.all():
+            for name in [template.key] + template.aliases:
+                if query in name:
+                    names.append(name)
+        return names
+
     def validate(self):
         """Ensure all template are valid and conflict-free."""
         templates = self.all()

memegen/test/test_services_template.py

@@ -27,6 +27,22 @@ def test_find_template_by_alias(self, template_service):
 
         assert 'hello' == template.key
 
+    def test_aliases(self, template_service):
+        template = Template('a', aliases=['b', 'c'])
+        template_service.template_store.filter.return_value = [template]
+
+        aliases = template_service.aliases()
+
+        assert ['a', 'b', 'c'] == sorted(aliases)
+
+    def test_aliases_with_filter(self, template_service):
+        template = Template('a1', aliases=['a2', 'b1'])
+        template_service.template_store.filter.return_value = [template]
+
+        aliases = template_service.aliases('a')
+
+        assert ['a1', 'a2'] == sorted(aliases)
+
     def test_validate_with_good_templates(self, template_service):
         templates = [Template(key='abc',
                               name="The ABC Meme"),

tests/test_routes_aliases.py

@@ -0,0 +1,35 @@
+# pylint: disable=unused-variable,misplaced-comparison-constant,expression-not-assigned
+
+from .conftest import load
+
+
+def describe_get():
+
+    def it_returns_all_aliases(client):
+        response = client.get("/aliases/")
+
+        assert 200 == response.status_code
+        assert len(load(response)) > 200
+
+    def describe_filter():
+
+        def with_single_match(client):
+            response = client.get("/aliases/?name=sad-biden")
+
+            assert 200 == response.status_code
+            assert {
+                'sad-biden': {
+                    'styles': [
+                        'down',
+                        'scowl',
+                        'window',
+                    ],
+                    'template': "http://localhost/templates/sad-biden"
+                }
+            } == load(response)
+
+        def with_many_matches(client):
+            response = client.get("/aliases/?name=votestakes")
+
+            assert 200 == response.status_code
+            assert len(load(response)) == 3

tests/test_routes_root.py

@@ -14,5 +14,6 @@ def test_get_root(self, client):
         assert 200 == response.status_code
         assert dict(
             templates="http://localhost/templates/",
+            aliases="http://localhost/aliases/",
             version="1",
         ) == load(response)