Merge pull request #153 from CorrosiveKid/id-lookup-testcase

Add example and test case to cover custom lookup field scenario

Author: barseghyanartur

examples/simple/factories/__init__.py

@@ -9,3 +9,4 @@
 from .books_order import *
 from .books_orderline import *
 from .books_publisher import *
+from .books_tag import *

examples/simple/search_indexes/documents/__init__.py

@@ -4,11 +4,13 @@
 from .city import CityDocument
 from .publisher import PublisherDocument
 from .location import LocationDocument
+from .tag import TagDocument
 
 __all___ = (
     'AddressDocument',
     'AuthorDocument',
     'BookDocument',
     'CityDocument',
     'PublisherDocument',
+    'TagDocument',
 )

examples/simple/search_indexes/documents/tag.py

@@ -0,0 +1,35 @@
+from django.conf import settings
+from django_elasticsearch_dsl import Document, Index, fields
+
+from books.models import Tag
+from .analyzers import html_strip
+
+
+__all__ = ('TagDocument',)
+
+INDEX = Index(settings.ELASTICSEARCH_INDEX_NAMES[__name__])
+
+INDEX.settings(
+    number_of_shards=1,
+    number_of_replicas=1,
+    blocks={'read_only_allow_delete': None}
+)
+
+
+@INDEX.doc_type
+class TagDocument(Document):
+    """Elasticsearch document for a Tag."""
+
+    # Set unique title as the document id.
+    id = fields.KeywordField(attr='title')
+    title = fields.KeywordField()
+
+    class Django(object):
+        """Django Elasticsearch DSL ORM Meta."""
+
+        model = Tag
+
+    class Meta(object):
+        """Meta options."""
+
+        parellel_indexing = True

examples/simple/search_indexes/serializers/__init__.py

@@ -10,6 +10,7 @@
     PublisherDocumentSerializer,
     PublisherDocumentSimpleSerializer,
 )
+from .tag import TagDocumentSerializer
 
 __all__ = (
     'AddressDocumentSerializer',
@@ -21,4 +22,5 @@
     'LocationDocumentSerializer',
     'PublisherDocumentSerializer',
     'PublisherDocumentSimpleSerializer',
+    'TagDocumentSerializer',
 )

examples/simple/search_indexes/serializers/tag.py

@@ -0,0 +1,19 @@
+from django_elasticsearch_dsl_drf.serializers import DocumentSerializer
+
+from ..documents import TagDocument
+
+
+__all__ = ('TagDocumentSerializer',)
+
+
+class TagDocumentSerializer(DocumentSerializer):
+    """Serializer for a Tag document."""
+
+    class Meta(object):
+        """Meta options."""
+
+        document = TagDocument
+        fields = (
+            'id',
+            'title',
+        )

examples/simple/search_indexes/urls.py

@@ -26,6 +26,7 @@
     LocationDocumentViewSet,
     PublisherDocumentViewSet,
     FrontAddressDocumentViewSet,
+    TagDocumentViewSet,
 )
 
 __all__ = ('urlpatterns',)
@@ -203,6 +204,16 @@
     basename='publisherdocument'
 )
 
+# *********************************************************
+# ************************* Tags **************************
+# *********************************************************
+
+router.register(
+    r'tags',
+    TagDocumentViewSet,
+    basename='tagdocument'
+)
+
 # **********************************************************
 # ********************** URL patterns **********************
 # **********************************************************

examples/simple/search_indexes/viewsets/__init__.py

@@ -23,6 +23,7 @@
 from .city import CityDocumentViewSet, CityCompoundSearchBackendDocumentViewSet
 from .location import LocationDocumentViewSet
 from .publisher import PublisherDocumentViewSet
+from .tag import TagDocumentViewSet
 
 __all__ = (
     'AddressDocumentViewSet',
@@ -50,4 +51,5 @@
     'LocationDocumentViewSet',
     'PublisherDocumentViewSet',
     'FrontAddressDocumentViewSet',
+    'TagDocumentViewSet',
 )

examples/simple/search_indexes/viewsets/tag.py

@@ -0,0 +1,19 @@
+from django_elasticsearch_dsl_drf.pagination import LimitOffsetPagination
+from django_elasticsearch_dsl_drf.viewsets import DocumentViewSet
+
+from ..documents import TagDocument
+from ..serializers import TagDocumentSerializer
+
+__all__ = (
+    'TagDocumentViewSet',
+)
+
+
+class TagDocumentViewSet(DocumentViewSet):
+    """Document viewset for tags."""
+
+    document = TagDocument
+    serializer_class = TagDocumentSerializer
+    lookup_field = 'title'
+    filter_backends = []
+    pagination_class = LimitOffsetPagination

examples/simple/settings/base.py

@@ -279,6 +279,7 @@
     'search_indexes.documents.address': 'address',
     'search_indexes.documents.author': 'author',
     'search_indexes.documents.book': 'book',
+    'search_indexes.documents.tag': 'tag',
     'search_indexes.documents.city': 'city',
     'search_indexes.documents.publisher': 'publisher',
     'search_indexes.documents.location': 'location',

examples/simple/settings/testing.py

@@ -17,6 +17,7 @@
     'search_indexes.documents.address': 'test_address',
     'search_indexes.documents.author': 'test_author',
     'search_indexes.documents.book': 'test_book',
+    'search_indexes.documents.tag': 'test_tag',
     'search_indexes.documents.city': 'test_city',
     'search_indexes.documents.publisher': 'test_publisher',
     'search_indexes.documents.location': 'test_location',