google books search endpoint

.travis.yml

@@ -23,6 +23,7 @@ env:
     - EMAIL_HOST_PASSWORD=''
     - GOOGLE_OAUTH2_CLIENT_ID=''
     - GOOGLE_OAUTH2_CLIENT_SECRET=''
+    - GOOGLE_BOOKS_API_KEY=''
 
 notifications:
   email:

stacks/books/gbs.py

@@ -134,7 +134,10 @@ class GoogleBooks(object):
 
     ENDPOINT = "https://www.googleapis.com/books/v1/volumes"
 
-    def __init__(self, **kwargs):
+    def __init__(self, apikey=None, **kwargs):
+
+        # add in the API key
+        self.apikey = apikey
 
         # add any additional parameters to query or orverride defaults:
         for (k, v) in kwargs.iteritems():
@@ -209,6 +212,11 @@ def get_required_params(self):
         Returns a dictionary of the parameters that must be added to the
         query.
         """
+        if self.apikey:
+            return {
+                "key": self.apikey,
+            }
+
         return {}
 
     def execute(self, params):
@@ -279,8 +287,9 @@ def authors(self):
         will be helpful
         Note: Currently yields full name strings.
         """
-        for author in self['authors']:
-            yield author
+        if self['authors']:
+            for author in self['authors']:
+                yield author
 
     @property
     def publisher(self):
@@ -341,6 +350,9 @@ def thumbnail_url(self):
         with the Google specific identifier.
         TODO: Strip weirdness out of URL
         """
+        if not self["imageLinks"]:
+            return None
+
         sizes = ("thumbnail", "smallThumbnail")
         for size in sizes:
             if size in self["imageLinks"]:
@@ -429,6 +441,7 @@ def serialize(self):
             'pages':       self.pages,
             'description': self.description,
             'language':    self.language,
+            'thumbnail':   self.thumbnail_url,
         }
 
     def __getitem__(self, name):

stacks/books/serializers.py

@@ -56,8 +56,8 @@ class BookMediaSerializer(serializers.ModelSerializer):
     download data for a piece of media for a book.
     """
 
-    book       = serializers.RelatedField(many=False)
-    uploader   = serializers.RelatedField(many=False)
+    book       = serializers.HyperlinkedRelatedField(view_name='api:book-detail', read_only=True)
+    uploader   = serializers.HyperlinkedRelatedField(view_name='api:user-detail', read_only=True)
     content    = AbsoluteFileField()
 
     class Meta:
@@ -88,7 +88,7 @@ class BookSerializer(serializers.ModelSerializer):
     publisher   = PublisherSerializer(many=False)
     media       = SimpleBookMediaSerializer(many=True)
     cover       = AbsoluteImageField()
-    tags        = serializers.RelatedField(many=True)
+    tags        = serializers.StringRelatedField(many=True)
     description = MarkdownField()
 
     class Meta:

stacks/books/views.py

@@ -59,6 +59,53 @@ class BookMediaViewSet(viewsets.ModelViewSet):
     queryset = BookMedia.objects.all()
     serializer_class = BookMediaSerializer
 
+
+from books.gbs import QueryBuilder, GoogleBooks
+from rest_framework.response import Response
+from rest_framework import status
+from django.conf import settings
+
+class GoogleBooksSearch(viewsets.ViewSet):
+
+    def list(self, request):
+        """
+        The search endpoint - queries the Google Books API.
+        """
+        isbn   = request.query_params.get('isbn')
+        title  = request.query_params.get('title')
+
+
+        if isbn:
+            # ISBN takes the highest preference
+            query  = QueryBuilder(isbn=isbn)
+
+        elif title:
+            # Search for title keywords as second preference
+            query  = QueryBuilder(intitle=title)
+
+        else:
+            # Required to search for either ISBN or Title
+            return Response({
+                "message": "Welcome to the Google Books Search interface, query with either title or isbn."
+            })
+
+        result = GoogleBooks(apikey=settings.GOOGLE_BOOKS_API_KEY).lookup(query)
+
+        if result is None:
+            return Response({
+                'isbn': isbn,
+                'success': False,
+                'message': "Could not find an ISBN that matched the query."
+            }, status=status.HTTP_404_NOT_FOUND)
+
+        elif isinstance(result, list):
+            return Response([
+                book.serialize() for book in result
+            ])
+
+        else:
+            return Response(result.serialize())
+
 ##########################################################################
 ## Normal HTTP Views for Browser
 ##########################################################################

stacks/stacks/settings/base.py

@@ -253,6 +253,12 @@ def environ_setting(name, default=None):
     'PAGINATE_BY': 50,
 }
 
+##########################################################################
+## Google Books API Key
+##########################################################################
+
+GOOGLE_BOOKS_API_KEY    = environ_setting('GOOGLE_BOOKS_API_KEY', '')
+
 ##########################################################################
 ## AWS Access Keys
 ##########################################################################

stacks/stacks/urls.py

@@ -27,6 +27,7 @@
 from rest_framework import routers
 from users.views import UserViewSet
 from stacks.views import HeartbeatViewSet
+from books.views import GoogleBooksSearch
 
 ##########################################################################
 ## Endpoint Discovery
@@ -36,6 +37,7 @@
 router = routers.DefaultRouter()
 router.register(r'users', UserViewSet)
 router.register(r'status', HeartbeatViewSet, "status")
+router.register(r'gbs', GoogleBooksSearch, "gbs")
 
 #############################################################################
 ## The URL Patterns for the app

stacks/stacks/utils/fields.py

@@ -53,7 +53,7 @@ def to_native(self, value):
 ##########################################################################
 
 
-class MarkdownField(serializers.WritableField):
+class MarkdownField(serializers.Field):
 
     def to_native(self, obj):
         return unicode(obj)