Merge branch 'ensure_mongo_indexes'

Author: nicolaiarocci

CHANGES

@@ -8,6 +8,12 @@ Development
 
 Version 0.8
 ~~~~~~~~~~~
+- New: Refactor index creation. We now have a new 
+  ``eve.io.mongo.ensure_mongo_indexes()`` function which ensures that eventual
+  ``mongo_indexes`` defined for a resource are created on the active
+  database. The function can be imported and invoked, for example in
+  multi-db workflows where a db is activated based on the
+  authenticated user performing the request (via custom auth classes).
 - Fix: add sphinxcontrib-embedly to dev-requirements.txt.
 - New: when the media endpoint is enabled, the default authentication class
   will be used to secure  it. Closes #1083.

eve/flaskapp.py

@@ -24,7 +24,8 @@
     error_endpoint, media_endpoint, schema_collection_endpoint, \
     schema_item_endpoint
 from eve.exceptions import ConfigException, SchemaException
-from eve.io.mongo import Mongo, Validator, GridFSMediaStorage, create_index
+from eve.io.mongo import Mongo, Validator, GridFSMediaStorage, \
+    ensure_mongo_indexes
 from eve.logging import RequestFilter
 from eve.utils import api_prefix, extract_key_values
 
@@ -894,16 +895,7 @@ def register_resource(self, resource, settings):
             )
 
         # create the mongo db indexes
-        mongo_indexes = self.config['DOMAIN'][resource]['mongo_indexes']
-        if mongo_indexes:
-            for name, value in mongo_indexes.items():
-                if isinstance(value, tuple):
-                    list_of_keys, index_options = value
-                else:
-                    list_of_keys = value
-                    index_options = {}
-
-                create_index(self, resource, name, list_of_keys, index_options)
+        ensure_mongo_indexes(self, resource)
 
         # flask-pymongo compatibility.
         if 'MONGO_OPTIONS' in self.config['DOMAIN']:

eve/io/mongo/__init__.py

@@ -11,6 +11,6 @@
 """
 
 # flake8: noqa
-from eve.io.mongo.mongo import Mongo, MongoJSONEncoder, create_index
+from eve.io.mongo.mongo import Mongo, MongoJSONEncoder, ensure_mongo_indexes
 from eve.io.mongo.validation import Validator
 from eve.io.mongo.media import GridFSMediaStorage

eve/io/mongo/mongo.py

@@ -943,7 +943,27 @@ def db(self):
         return self.mongo.pymongo().db
 
 
-def create_index(app, resource, name, list_of_keys, index_options):
+def ensure_mongo_indexes(app, resource):
+    """ Make sure 'mongo_indexes' is respected and mongo indexes are created on
+    the current database.
+
+    .. versionaddded:: 0.8
+    """
+    mongo_indexes = app.config['DOMAIN'][resource]['mongo_indexes']
+    if not mongo_indexes:
+        return
+
+    for name, value in mongo_indexes.items():
+        if isinstance(value, tuple):
+            list_of_keys, index_options = value
+        else:
+            list_of_keys = value
+            index_options = {}
+
+        _create_index(app, resource, name, list_of_keys, index_options)
+
+
+def _create_index(app, resource, name, list_of_keys, index_options):
     """ Create a specific index composed of the `list_of_keys` for the
     mongo collection behind the `resource` using the `app.config`
     to retrieve all data needed to find out the mongodb configuration.
@@ -965,14 +985,20 @@ def create_index(app, resource, name, list_of_keys, index_options):
         {"sparse": True}
 
     .. versionadded:: 0.6
+
     """
     # it doesn't work as a typical mongodb method run in the request
     # life cycle, it is just called when the app start and it uses
     # pymongo directly.
     collection = app.config['SOURCES'][resource]['source']
 
     # get db for given prefix
-    px = app.config['DOMAIN'][resource].get('mongo_prefix', 'MONGO')
+    try:
+        # mongo_prefix might have been set by Auth class instance
+        px = g.get('mongo_prefix')
+    except:
+        px = app.config['DOMAIN'][resource].get('mongo_prefix', 'MONGO')
+
     with app.app_context():
         db = app.data.pymongo(resource, px).db
 
@@ -989,8 +1015,9 @@ def create_index(app, resource, name, list_of_keys, index_options):
         except pymongo.errors.OperationFailure as e:
             if e.code == 85:
                 # This error is raised when the definition of the index has
-                # been changed, we didn't found any spec out there but we think
-                # that this error is not going to change and we can trust.
+                # been changed, we didn't find any spec out there but we
+                # think that this error is not going to change and we can
+                # trust.
 
                 # by default, drop the old index with old configuration and
                 # create the index again with the new configuration.