Add tags capaciy, close #5

Author: dethi

README.md

@@ -98,44 +98,55 @@ We recommend the usage of our [JavaScript API Client](https://github.com/algolia
 
 ## Geo-Search
 
-Use the `geo_field` attribute to localize your record. `geo_field` can be a tuple or a callable that return a tuple (latitude, longitude).
+Use the `geo_field` attribute to localize your record. `geo_field` should be a callable that returns a tuple (latitude, longitude).
 
 ```python
-class Contact(models.Model):
-    name = models.CharField()
-    lat = models.FloatField()
-    lng = models.FloatField()
+class contact(models.model):
+    name = models.charfield()
+    lat = models.floatfield()
+    lng = models.floatfield()
 
     def location(self):
         return (self.lat, self.lng)
 
 
-class ContactIndex(AlgoliaIndex):
+class contactindex(algoliaindex):
     fields = 'name'
     geo_field = 'location'
 
 
-algoliasearch.register(Contact, ContactIndex)
+algoliasearch.register(contact, contactindex)
 ```
 
-# Options
+# Tags
 
-## Custom `objectID`
-
-You can choose which field will be used as the `objectID`. The field should be unique and can be a string or integer. By default, we use the `pk` field of the model.
+Use the `tags` attributes to add tags to your record. It can be a field or a callable.
 
 ```python
 class ArticleIndex(AlgoliaIndex):
-    custom_objectID = 'post_id'
+    tags = 'category'
+```
+
+At query time, specify `{ tagFilters: 'tagvalue' }` or `{ tagFilters: ['tagvalue1', 'tagvalue2'] }` as search parameters to restrict the result set to specific tags.
+
+# options
+
+## custom `objectid`
+
+you can choose which field will be used as the `objectid`. the field should be unique and can be a string or integer. by default, we use the `pk` field of the model.
+
+```python
+class articleindex(algoliaindex):
+    custom_objectid = 'post_id'
 ```
 
-## Custom index name
+## custom index name
 
-You can customize the inde name. By default, the index name will be the name of the model class.
+You can customize the index name. By default, the index name will be the name of the model class.
 
 ```python
-class ContactIndex(AlgoliaIndex):
-    index_name = 'Entreprise'
+class contactindex(algoliaindex):
+    index_name = 'entreprise'
 ```
 
 ## Index settings

src/models.py

@@ -25,9 +25,12 @@ class AlgoliaIndex(object):
     fields = ()
 
     # Use to specify the geo-fields that should be used for location search.
-    # The field should be a tuple or a callable that returns a tuple.
+    # The field should be a callable that returns a tuple.
     geo_field = None
 
+    # Use to specify the field that should be used for filtering by tag.
+    tags = None
+
     # Use to specify the index to target on Algolia.
     index_name = None
 
@@ -60,19 +63,30 @@ def __init__(self, model, client):
             self.fields = all_fields
             self.fields.remove('id')
 
-        # Check geo_field
-        if self.geo_field:
-            if not hasattr(model, self.geo_field):
-                raise AlgoliaIndexError('{} is not an attribute of {}.'.format(
-                    self.geo_field, model))
-
         # Check custom_objectID
         if self.custom_objectID:
             if not (hasattr(model, self.custom_objectID) or
                     (self.custom_objectID in all_fields)):
                 raise AlgoliaIndex('{} is not an attribute of {}.'.format(
                     self.custom_objectID, model))
 
+        # Check tags
+        if self.tags:
+            if not (hasattr(model, self.tags) or (self.tags in all_fields)):
+                raise AlgoliaIndex('{} is not an attribute of {}'.format(
+                    self.tags, model))
+
+        # Check geo_field
+        if self.geo_field:
+            if hasattr(model, self.geo_field):
+                attr = getattr(model, self.geo_field)
+                if not callable(attr):
+                    raise AlgoliaIndexError('{} should be a callable.'.format(
+                        self.geo_field))
+            else:
+                raise AlgoliaIndexError('{} is not an attribute of {}.'.format(
+                    self.geo_field, model))
+
     def __set_index(self, client):
         '''Get an instance of Algolia Index'''
         params = getattr(settings, 'ALGOLIA', None)
@@ -98,11 +112,14 @@ def __set_index(self, client):
     def __get_objectID(self, instance):
         '''Return the objectID of an instance.'''
         if self.custom_objectID:
-            return getattr(instance, self.custom_objectID)
+            attr = getattr(instance, self.custom_objectID)
+            if callable(attr):
+                attr = attr()
+            return attr
         else:
             return instance.pk
 
-    def __build_object(self, instance):
+    def _build_object(self, instance):
         '''Build the JSON object.'''
         tmp = {'objectID': self.__get_objectID(instance)}
         if isinstance(self.fields, dict):
@@ -123,12 +140,21 @@ def __build_object(self, instance):
             if callable(attr):
                 attr = attr()
             tmp['_geoloc'] = {'lat': attr[0], 'lng': attr[1]}
+
+        if self.tags:
+            attr = getattr(instance, self.tags)
+            if callable(attr):
+                attr = attr()
+            if not isinstance(attr, list):
+                attr = list(attr)
+            tmp['_tags'] = attr
+
         logger.debug('BUILD %s FROM %s', tmp['objectID'], self.model)
         return tmp
 
     def update_obj_index(self, instance):
         '''Update the object.'''
-        obj = self.__build_object(instance)
+        obj = self._build_object(instance)
         self.__index.save_object(obj)
         logger.debug('UPDATE %s FROM %s', obj['objectID'], self.model)
 
@@ -161,7 +187,7 @@ def reindex_all(self, batch_size=1000):
         counts = 0
         batch = []
         for instance in self.model.objects.all():
-            batch.append(self.__build_object(instance))
+            batch.append(self._build_object(instance))
             if len(batch) >= batch_size:
                 result = self.__tmp_index.save_objects(batch)
                 logger.info('SAVE %d OBJECTS TO %s_tmp', len(batch),

tests/test_index.py

@@ -41,23 +41,23 @@ class ExampleIndex(AlgoliaIndex):
             geo_field = 'location'
 
         index = ExampleIndex(Example, self.client)
-        obj = index._AlgoliaIndex__build_object(self.instance)
+        obj = index._build_object(self.instance)
         self.assertEqual(obj['_geoloc'], {'lat': 63.3, 'lng': -32.0})
 
     def test_custom_objectID(self):
         class ExampleIndex(AlgoliaIndex):
             custom_objectID = 'uid'
 
         index = ExampleIndex(Example, self.client)
-        obj = index._AlgoliaIndex__build_object(self.instance)
+        obj = index._build_object(self.instance)
         self.assertEqual(obj['objectID'], 4)
 
     def test_one_field(self):
         class ExampleIndex(AlgoliaIndex):
             fields = 'name'
 
         index = ExampleIndex(Example, self.client)
-        obj = index._AlgoliaIndex__build_object(self.instance)
+        obj = index._build_object(self.instance)
         self.assertNotIn('uid', obj)
         self.assertIn('name', obj)
         self.assertNotIn('address', obj)
@@ -71,7 +71,7 @@ class ExampleIndex(AlgoliaIndex):
             fields = ('name', 'address')
 
         index = ExampleIndex(Example, self.client)
-        obj = index._AlgoliaIndex__build_object(self.instance)
+        obj = index._build_object(self.instance)
         self.assertNotIn('uid', obj)
         self.assertIn('name', obj)
         self.assertIn('address', obj)