mirror of
https://github.com/bookwyrm-social/bookwyrm.git
synced 2024-06-27 17:30:38 +00:00
161 lines
4.2 KiB
Python
161 lines
4.2 KiB
Python
''' functionality outline for a book data connector '''
|
|
from abc import ABC, abstractmethod
|
|
from dateutil import parser
|
|
import pytz
|
|
import requests
|
|
|
|
from fedireads import models
|
|
|
|
|
|
class AbstractConnector(ABC):
|
|
''' generic book data connector '''
|
|
|
|
def __init__(self, identifier):
|
|
# load connector settings
|
|
info = models.Connector.objects.get(identifier=identifier)
|
|
self.connector = info
|
|
|
|
self.base_url = info.base_url
|
|
self.books_url = info.books_url
|
|
self.covers_url = info.covers_url
|
|
self.search_url = info.search_url
|
|
self.key_name = info.key_name
|
|
self.max_query_count = info.max_query_count
|
|
self.name = info.name
|
|
self.local = info.local
|
|
self.id = info.id
|
|
|
|
|
|
def is_available(self):
|
|
''' check if you're allowed to use this connector '''
|
|
if self.max_query_count is not None:
|
|
if self.connector.query_count >= self.max_query_count:
|
|
return False
|
|
return True
|
|
|
|
|
|
def search(self, query):
|
|
''' free text search '''
|
|
resp = requests.get(
|
|
'%s%s' % (self.search_url, query),
|
|
headers={
|
|
'Accept': 'application/json; charset=utf-8',
|
|
},
|
|
)
|
|
if not resp.ok:
|
|
resp.raise_for_status()
|
|
data = resp.json()
|
|
results = []
|
|
|
|
for doc in data['docs'][:10]:
|
|
results.append(self.format_search_result(doc))
|
|
return results
|
|
|
|
|
|
@abstractmethod
|
|
def format_search_result(self, search_result):
|
|
''' create a SearchResult obj from json '''
|
|
|
|
|
|
@abstractmethod
|
|
def get_or_create_book(self, book_id):
|
|
''' request and format a book given an identifier '''
|
|
# return book model obj
|
|
|
|
|
|
@abstractmethod
|
|
def expand_book_data(self, book):
|
|
''' get more info on a book '''
|
|
|
|
|
|
@abstractmethod
|
|
def get_or_create_author(self, book_id):
|
|
''' request and format a book given an identifier '''
|
|
# return book model obj
|
|
|
|
|
|
@abstractmethod
|
|
def update_book(self, book_obj, data=None):
|
|
''' sync a book with the canonical remote copy '''
|
|
# return book model obj
|
|
|
|
|
|
def update_from_mappings(obj, data, mappings):
|
|
''' assign data to model with mappings '''
|
|
noop = lambda x: x
|
|
mappings['authors'] = ('', noop)
|
|
mappings['parent_work'] = ('', noop)
|
|
for (key, value) in data.items():
|
|
formatter = None
|
|
if key in mappings:
|
|
key, formatter = mappings[key]
|
|
if not formatter:
|
|
formatter = noop
|
|
|
|
if key == 'id':
|
|
continue
|
|
|
|
if has_attr(obj, key):
|
|
obj.__setattr__(key, formatter(value))
|
|
return obj
|
|
|
|
|
|
def match_from_mappings(data, mappings):
|
|
''' try to find existing copies of this book using various keys '''
|
|
keys = [
|
|
('openlibrary_key', models.Book),
|
|
('librarything_key', models.Book),
|
|
('goodreads_key', models.Book),
|
|
('lccn', models.Work),
|
|
('isbn_10', models.Edition),
|
|
('isbn_13', models.Edition),
|
|
('oclc_number', models.Edition),
|
|
('asin', models.Edition),
|
|
]
|
|
noop = lambda x: x
|
|
for key, model in keys:
|
|
formatter = None
|
|
if key in mappings:
|
|
key, formatter = mappings[key]
|
|
if not formatter:
|
|
formatter = noop
|
|
|
|
value = data.get(key)
|
|
if not value:
|
|
continue
|
|
value = formatter(value)
|
|
|
|
match = model.objects.select_subclasses().filter(
|
|
**{key: value}).first()
|
|
if match:
|
|
return match
|
|
|
|
|
|
def has_attr(obj, key):
|
|
''' helper function to check if a model object has a key '''
|
|
try:
|
|
return hasattr(obj, key)
|
|
except ValueError:
|
|
return False
|
|
|
|
|
|
def get_date(date_string):
|
|
''' helper function to try to interpret dates '''
|
|
try:
|
|
return pytz.utc.localize(parser.parse(date_string))
|
|
except ValueError:
|
|
return None
|
|
|
|
|
|
class SearchResult:
|
|
''' standardized search result object '''
|
|
def __init__(self, title, key, author, year):
|
|
self.title = title
|
|
self.key = key
|
|
self.author = author
|
|
self.year = year
|
|
|
|
def __repr__(self):
|
|
return "<SearchResult key={!r} title={!r} author={!r}>".format(
|
|
self.key, self.title, self.author)
|