Merge pull request #91 from wcdolphin/master

Supply a Flask JSON Encoder

Author: itsnauman

.travis.yml

@@ -8,10 +8,17 @@ python:
 env:
   - PYMONGO=dev MONGOENGINE=dev
   - PYMONGO=dev MONGOENGINE=0.7.10
-  - PYMONGO=dev MONGOENGINE=0.8.0RC2
+  - PYMONGO=dev MONGOENGINE=0.8.0
+  - PYMONGO=dev MONGOENGINE=0.8.7
   - PYMONGO=2.5 MONGOENGINE=dev
   - PYMONGO=2.5 MONGOENGINE=0.7.10
-  - PYMONGO=2.5 MONGOENGINE=0.8.0RC2
+  - PYMONGO=2.5 MONGOENGINE=0.8.0
+  - PYMONGO=2.5 MONGOENGINE=0.8.7
+  - PYMONGO=2.7 MONGOENGINE=dev
+  - PYMONGO=2.7 MONGOENGINE=0.7.10
+  - PYMONGO=2.7 MONGOENGINE=0.8.0
+  - PYMONGO=2.7 MONGOENGINE=0.8.7
+
 install:
     - if [[ $PYMONGO == 'dev' ]]; then pip install https://github.com/mongodb/mongo-python-driver/tarball/master; true; fi
     - if [[ $PYMONGO != 'dev' ]]; then pip install pymongo==$PYMONGO --use-mirrors; true; fi

flask_mongoengine/__init__.py

@@ -10,6 +10,7 @@
 
 from .sessions import *
 from .pagination import *
+from .json import overide_json_encoder
 
 
 def _include_mongoengine(obj):
@@ -67,6 +68,8 @@ def init_app(self, app):
         app.extensions = getattr(app, 'extensions', {})
         app.extensions['mongoengine'] = self
         self.app = app
+        overide_json_encoder(app)
+
 
 class BaseQuerySet(QuerySet):
     """

flask_mongoengine/json.py

@@ -0,0 +1,37 @@
+from flask.json import JSONEncoder
+from bson import json_util
+from mongoengine.base import BaseDocument
+try:
+    from mongoengine.base import BaseQuerySet
+except ImportError as ie: # support mongoengine < 0.7
+    from mongoengine.queryset import QuerySet as BaseQuerySet
+
+def _make_encoder(superclass):
+    class MongoEngineJSONEncoder(superclass):
+        '''
+        A JSONEncoder which provides serialization of MongoEngine
+        documents and queryset objects.
+        '''
+        def default(self, obj):
+            if isinstance(obj, BaseDocument):
+                return json_util._json_convert(obj.to_mongo())
+            elif isinstance(obj, BaseQuerySet):
+                return json_util._json_convert(obj.as_pymongo())
+            return superclass.default(self, obj)
+    return MongoEngineJSONEncoder
+
+MongoEngineJSONEncoder = _make_encoder(JSONEncoder)
+
+
+def overide_json_encoder(app):
+    '''
+    A function to dynamically create a new MongoEngineJSONEncoder class
+    based upon a custom base class.
+    This function allows us to combine MongoEngine serialization with
+    any changes to Flask's JSONEncoder which a user may have made
+    prior to calling init_app.
+
+    NOTE: This does not cover situations where users override
+    an instance's json_encoder after calling init_app.
+    '''
+    app.json_encoder = _make_encoder(app.json_encoder)

tests/test_json.py

@@ -0,0 +1,48 @@
+import sys
+sys.path[0:0] = [""]
+
+import unittest
+import datetime
+import flask
+
+from flask.ext.mongoengine import MongoEngine
+from flask.ext.mongoengine.json import MongoEngineJSONEncoder
+
+
+class DummyEncoder(flask.json.JSONEncoder):
+    '''
+    An example encoder which a user may create and override
+    the apps json_encoder with.
+    This class is a NO-OP, but used to test proper inheritance.
+    '''
+
+
+class JSONAppTestCase(unittest.TestCase):
+
+    def dictContains(self,superset,subset):
+        for k,v in subset.items():
+            if not superset[k] == v:
+                return False
+        return True
+
+    def assertDictContains(self,superset,subset):
+        return self.assertTrue(self.dictContains(superset,subset))
+
+    def setUp(self):
+        app = flask.Flask(__name__)
+        app.config['MONGODB_DB'] = 'testing'
+        app.config['TESTING'] = True
+        app.json_encoder = DummyEncoder
+        db = MongoEngine()
+        db.init_app(app)
+
+        self.app = app
+        self.db = db
+
+    def test_inheritance(self):
+        self.assertTrue(issubclass(self.app.json_encoder, DummyEncoder))
+        json_encoder_name = self.app.json_encoder.__name__
+
+        # Since the class is dynamically derrived, must compare class names
+        # rather than class objects.
+        self.assertEqual(json_encoder_name, 'MongoEngineJSONEncoder')

tests/test_json_app.py

@@ -0,0 +1,111 @@
+import sys
+sys.path[0:0] = [""]
+
+import unittest
+import datetime
+import flask
+
+from flask.ext.mongoengine import MongoEngine
+
+class JSONAppTestCase(unittest.TestCase):
+
+    def dictContains(self,superset,subset):
+        for k,v in subset.items():
+            if not superset[k] == v:
+                return False
+        return True
+
+    def assertDictContains(self,superset,subset):
+        return self.assertTrue(self.dictContains(superset,subset))
+
+    def setUp(self):
+        app = flask.Flask(__name__)
+        app.config['MONGODB_DB'] = 'testing'
+        app.config['TESTING'] = True
+        db = MongoEngine()
+
+        class Todo(db.Document):
+            title = db.StringField(max_length=60)
+            text = db.StringField()
+            done = db.BooleanField(default=False)
+            pub_date = db.DateTimeField(default=datetime.datetime.now)
+
+        db.init_app(app)
+
+        Todo.drop_collection()
+        self.Todo = Todo
+
+        @app.route('/')
+        def index():
+            return flask.jsonify(result=self.Todo.objects())
+
+        @app.route('/add', methods=['POST'])
+        def add():
+            form = flask.request.form
+            todo = self.Todo(title=form['title'],
+                             text=form['text'])
+            todo.save()
+            return flask.jsonify(result=todo)
+
+        @app.route('/show/<id>/')
+        def show(id):
+            return flask.jsonify(result=self.Todo.objects.get_or_404(id=id))
+
+
+        self.app = app
+        self.db = db
+
+
+    def test_connection_kwargs(self):
+        app = flask.Flask(__name__)
+        app.config['MONGODB_SETTINGS'] = {
+            'DB': 'testing_tz_aware',
+            'alias': 'tz_aware_true',
+            'TZ_AWARE': True,
+        }
+        app.config['TESTING'] = True
+        db = MongoEngine()
+        db.init_app(app)
+        self.assertTrue(db.connection.tz_aware)
+
+        app.config['MONGODB_SETTINGS'] = {
+            'DB': 'testing',
+            'alias': 'tz_aware_false',
+        }
+        db.init_app(app)
+        self.assertFalse(db.connection.tz_aware)
+
+    def test_with_id(self):
+        c = self.app.test_client()
+        resp = c.get('/show/38783728378090/')
+        self.assertEqual(resp.status_code, 404)
+
+        rv = c.post('/add', data={'title': 'First Item', 'text': 'The text'})
+        self.assertEqual(rv.status_code,200)
+
+        resp = c.get('/show/%s/' % self.Todo.objects.first().id)
+        self.assertEqual(resp.status_code, 200)
+        res = flask.json.loads(resp.data).get('result')
+        self.assertDictContains(res,{
+                'title': 'First Item',
+                'text': 'The text'
+            })
+
+    def test_basic_insert(self):
+        c = self.app.test_client()
+        d1 = {'title': 'First Item', 'text': 'The text'}
+        d2 = {'title': '2nd Item', 'text': 'The text'}
+        c.post('/add', data=d1)
+        c.post('/add', data=d2)
+        rv = c.get('/')
+        result = flask.json.loads(rv.data).get('result')
+
+        self.assertEqual(len(result),2)
+
+        # ensure each of the objects is one of the two we already
+        # inserted
+        for obj in result:
+            self.assertTrue(any([
+                self.dictContains(obj,d1),
+                self.dictContains(obj,d2)
+                ]))