fix bug with custom_objectID

Author: dethi

.coveragerc

@@ -1,10 +1,12 @@
 Algolia Search for Django
 ==================
 
-This package let you easily integrate the Algolia Search API to your favorite ORM. It's based on the [algoliasearch-client-python](https://github.com/algolia/algoliasearch-client-python) package. Both Python 2.x and 3.x are supported.
+This package let you easily integrate the Algolia Search API to your favorite ORM. It's based on the [algoliasearch-client-python](https://github.com/algolia/algoliasearch-client-python) package.
 
 You might be interested in the sample Django application providing a typeahead.js based auto-completion and Google-like instant search: [algoliasearch-django-example](https://github.com/algolia/algoliasearch-django-example)
 
+Compatible with **Python 2.7**, **Python 3.2+** and **Django 1.7+**
+
 [![Build Status](https://travis-ci.org/algolia/algoliasearch-django.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-django)
 [![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-django/badge.svg?branch=master)](https://coveralls.io/r/algolia/algoliasearch-django)
 [![PyPI version](https://badge.fury.io/py/algoliasearch-django.svg?branch=master)](http://badge.fury.io/py/algoliasearch-django)

README.md

@@ -1,3 +1,3 @@
-django
+django>=1.7
 algoliasearch
 tox

requirements.txt

@@ -41,7 +41,7 @@
         'django.contrib.algoliasearch.management': 'src/management',
         'django.contrib.algoliasearch.management.commands': 'src/management/commands'
     },
-    install_requires = ['django', 'algoliasearch'],
+    install_requires = ['django>=1.7', 'algoliasearch'],
     description = 'Algolia Search integration for Django',
     long_description = README,
     author = 'Algolia Team',

setup.py

@@ -63,24 +63,14 @@ def __init__(self, model, client):
 
         # Check geo_field
         if self.geo_field:
-            if hasattr(model, self.geo_field):
-                attr = getattr(model, self.geo_field)
-                if not (isinstance(attr, tuple) or callable(attr)):
-                    raise AlgoliaIndexError(
-                        '`geo_field` should be a tuple or a callable that returns a tuple.')
-            else:
+            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 hasattr(model, self.custom_objectID):
-                attr = getattr(model, elf.custom_objectID)
-                if not (isinstance(attr, str) or isinstance(attr, int)):
-                    raise AlgoliaIndexError(
-                        '`custom_objectID` should be a string or an integer.')
-            else:
-                raise AlgoliaIndex('`{}` is not an attribute of {}.'.format(
+            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))
 
     def __set_index(self, client):
@@ -108,7 +98,7 @@ def __set_index(self, client):
     def __get_objectID(self, instance):
         '''Return the objectID of an instance.'''
         if self.custom_objectID:
-            return getattr(instance, custom_objectID)
+            return getattr(instance, self.custom_objectID)
         else:
             return instance.pk
 

src/models.py

@@ -2,6 +2,7 @@
 
 
 class Example(models.Model):
+    uid = models.IntegerField()
     name = models.CharField(max_length=20)
     address = models.CharField(max_length=200)
     lat = models.FloatField()

tests/models.py

@@ -61,6 +61,6 @@
 ALGOLIA = {
     'APPLICATION_ID': os.getenv('ALGOLIA_APPLICATION_ID'),
     'API_KEY': os.getenv('ALGOLIA_API_KEY'),
-    'INDEX_PREFIX': 'django',
+    'INDEX_PREFIX': 'django' + os.getenv('TRAVIS_JOB_NUMBER', ''),
     'INDEX_SUFFIX': 'test'
 }

tests/settings.py

@@ -3,13 +3,16 @@
 
 from django.contrib.algoliasearch import AlgoliaIndex
 from django.contrib.algoliasearch import algolia_engine
+from django.contrib.algoliasearch.models import AlgoliaIndexError
 
 from .models import Example
 
 
 class IndexTestCase(TestCase):
     def setUp(self):
         self.client = algolia_engine.client
+        self.instance = Example(uid=4, name='SuperK', address='Finland',
+                lat=63.3, lng=-32.0)
 
     def test_default_index_name(self):
         index = AlgoliaIndex(Example, self.client)
@@ -21,3 +24,54 @@ class ExampleIndex(AlgoliaIndex):
 
         index = ExampleIndex(Example, self.client)
         self.assertEqual(index.index_name, 'django_customName_test')
+
+    def test_geo_fields(self):
+        class ExampleIndex(AlgoliaIndex):
+            geo_field = 'location'
+
+        index = ExampleIndex(Example, self.client)
+        obj = index._AlgoliaIndex__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)
+        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)
+        self.assertNotIn('uid', obj)
+        self.assertIn('name', obj)
+        self.assertNotIn('address', obj)
+        self.assertNotIn('lat', obj)
+        self.assertNotIn('lng', obj)
+        self.assertNotIn('location', obj)
+        self.assertEqual(len(obj), 2)
+
+    def test_multiple_fields(self):
+        class ExampleIndex(AlgoliaIndex):
+            fields = ('name', 'address')
+
+        index = ExampleIndex(Example, self.client)
+        obj = index._AlgoliaIndex__build_object(self.instance)
+        self.assertNotIn('uid', obj)
+        self.assertIn('name', obj)
+        self.assertIn('address', obj)
+        self.assertNotIn('lat', obj)
+        self.assertNotIn('lng', obj)
+        self.assertNotIn('location', obj)
+        self.assertEqual(len(obj), 3)
+
+    def test_invalid_fields(self):
+        class ExampleIndex(AlgoliaIndex):
+            fields = ('name', 'color')
+
+        with self.assertRaises(AlgoliaIndexError):
+            index = ExampleIndex(Example, self.client)