<gh_stars>1-10
'''
record.py: the TindRecord object class for Topi

Authors
-------

<NAME> <<EMAIL>> -- Caltech Library

Copyright
---------

Copyright (c) 2021 by the California Institute of Technology.  This code
is open-source software released under a 3-clause BSD license.  Please see the
file "LICENSE" for more information.
'''

import json
from   json import JSONDecodeError

if __debug__:
    from sidetrack import log

from .tind_utils import result_from_api
from .exceptions import DataMismatchError


# Constants.
# .............................................................................

# URL template for thumbnail images. The result is returned as JSON.
# The first placeholder is for the host URL; the second is for a TIND record id.
# Use Python .format() to substitute the relevant values into the string.
_THUMBNAIL_FOR_TIND_ID = '{}/nanna/thumbnail/{}'


# Class definitions.
# .............................................................................

class TindRecord():
    '''Object class for representing a record from TIND.'''

    # The reason for an explicit list of fields here is so that we can use it
    # in the definition of __repr__().
    __fields = {
        'tind_id'       : str,          # Tind id == MARC control field 001
        'tind_url'      : str,          # Page for the record in TIND
        'title'         : str,          # MARC data field 245
        'subtitle'      : str,          # MARC data field 245
        'author'        : str,          # MARC data field 245 or 100
        'edition'       : str,          # MARC data field 250
        'publisher'     : str,          # MARC data field 260
        'year'          : str,          # extracted from control field 008
        'isbn_issn'     : list,         # MARC data field 020
        'description'   : str,          # MARC data field 300 concatenated
        'bib_note'      : str,          # MARC data field 504a
        'thumbnail_url' : str,          # Cover image shown on TIND record page
        'items'         : list,         # list of TindItem objects
    }


    def __init__(self, server_url = None, **kwargs):
        # Internal variables.  Need to set these first.
        self._server_url = server_url
        self._saved_thumbnail_url = None

        # Always first initialize every field.
        for field, field_type in self.__fields.items():
            setattr(self, field, ([] if field_type == list else ''))
        # Set values if given arguments.
        for field, value in kwargs.items():
            setattr(self, field, value)


    def __getattribute__(self, attr):
        if attr == 'thumbnail_url':
            if self._saved_thumbnail_url is not None:
                return self._saved_thumbnail_url
            if __debug__: log(f'getting thumbnail url')
            self._saved_thumbnail_url = self._thumbnail_for_record()
            return self._saved_thumbnail_url
        return object.__getattribute__(self, attr)


    def __setattr__(self, attr, value):
        if attr == 'tind_id' and getattr(self, "_server_url", None):
            object.__setattr__(self, 'tind_url', f'{self._server_url}/record/{value}')
        object.__setattr__(self, attr, value)


    def __str__(self):
        details = f' {self.tind_id}' if self.tind_id else ''
        return f'TindRecord{details}'


    def __repr__(self):
        field_values = []
        for field in sorted(self.__fields.keys()):
            value = getattr(self, field, None)
            printed_value = value if isinstance(value, list) else f'"{value}"'
            field_values.append(f'{field}={printed_value}')
        return 'TindRecord(' + ', '.join(field_values) + ')'


    def __eq__(self, other):
        if isinstance(other, type(self)):
            return self.__dict__ == other.__dict__
        return NotImplemented


    def __ne__(self, other):
        # Based on lengthy Stack Overflow answer by user "Maggyero" posted on
        # 2018-06-02 at https://stackoverflow.com/a/50661674/743730
        eq = self.__eq__(other)
        if eq is not NotImplemented:
            return not eq
        return NotImplemented


    def __lt__(self, other):
        return self.tind_id < other.tind_id


    def __gt__(self, other):
        if isinstance(other, type(self)):
            return other.tind_id < self.tind_id
        return NotImplemented


    def __le__(self, other):
        if isinstance(other, type(self)):
            return not other.tind_id < self.tind_id
        return NotImplemented


    def __ge__(self, other):
        if isinstance(other, type(self)):
            return not self.tind_id < other.tind_id
        return NotImplemented


    def _thumbnail_for_record(self, retry = 0):
        '''Return the URL for the thumbnail in TIND for this record.'''
        def response_handler(resp):
            if not resp:
                if __debug__: log(f'got empty json for thumbnail for {self.tind_id}')
                return ''
            try:
                data = json.loads(resp.text)
            except JSONDecodeError as ex:
                raise TindError(f'Malformed result from {self._server_url}: str(ex)')
            except TypeError as ex:
                raise DataMismatchError(f'Unexpected data returned by {self._server_url}.')

            if 'big' in data:
                if __debug__: log(f'thumbnail for {self.tind_id} is {data["big"]}')
                return data['big']
            elif 'medium' in data:
                if __debug__: log(f'thumbnail for {self.tind_id} is {data["medium"]}')
                return data['medium']
            elif 'small' in data:
                if __debug__: log(f'thumbnail for {self.tind_id} is {data["small"]}')
                return data['small']
            else:
                if __debug__: log(f'could not find thumbnail for {self.tind_id}')
                return ''

        endpoint = _THUMBNAIL_FOR_TIND_ID.format(self._server_url, self.tind_id)
        return result_from_api(endpoint, response_handler)

'''
record.py: the TindRecord object class for Topi

Authors
-------

<NAME> <<EMAIL>> -- Caltech Library

Copyright
---------

Copyright (c) 2021 by the California Institute of Technology.  This code
is open-source software released under a 3-clause BSD license.  Please see the
file "LICENSE" for more information.
'''

import json
from   json import JSONDecodeError

if __debug__:
    from sidetrack import log

from .tind_utils import result_from_api
from .exceptions import DataMismatchError


# Constants.
# .............................................................................

# URL template for thumbnail images. The result is returned as JSON.
# The first placeholder is for the host URL; the second is for a TIND record id.
# Use Python .format() to substitute the relevant values into the string.
_THUMBNAIL_FOR_TIND_ID = '{}/nanna/thumbnail/{}'


# Class definitions.
# .............................................................................

class TindRecord():
    '''Object class for representing a record from TIND.'''

    # The reason for an explicit list of fields here is so that we can use it
    # in the definition of __repr__().
    __fields = {
        'tind_id'       : str,          # Tind id == MARC control field 001
        'tind_url'      : str,          # Page for the record in TIND
        'title'         : str,          # MARC data field 245
        'subtitle'      : str,          # MARC data field 245
        'author'        : str,          # MARC data field 245 or 100
        'edition'       : str,          # MARC data field 250
        'publisher'     : str,          # MARC data field 260
        'year'          : str,          # extracted from control field 008
        'isbn_issn'     : list,         # MARC data field 020
        'description'   : str,          # MARC data field 300 concatenated
        'bib_note'      : str,          # MARC data field 504a
        'thumbnail_url' : str,          # Cover image shown on TIND record page
        'items'         : list,         # list of TindItem objects
    }


    def __init__(self, server_url = None, **kwargs):
        # Internal variables.  Need to set these first.
        self._server_url = server_url
        self._saved_thumbnail_url = None

        # Always first initialize every field.
        for field, field_type in self.__fields.items():
            setattr(self, field, ([] if field_type == list else ''))
        # Set values if given arguments.
        for field, value in kwargs.items():
            setattr(self, field, value)


    def __getattribute__(self, attr):
        if attr == 'thumbnail_url':
            if self._saved_thumbnail_url is not None:
                return self._saved_thumbnail_url
            if __debug__: log(f'getting thumbnail url')
            self._saved_thumbnail_url = self._thumbnail_for_record()
            return self._saved_thumbnail_url
        return object.__getattribute__(self, attr)


    def __setattr__(self, attr, value):
        if attr == 'tind_id' and getattr(self, "_server_url", None):
            object.__setattr__(self, 'tind_url', f'{self._server_url}/record/{value}')
        object.__setattr__(self, attr, value)


    def __str__(self):
        details = f' {self.tind_id}' if self.tind_id else ''
        return f'TindRecord{details}'


    def __repr__(self):
        field_values = []
        for field in sorted(self.__fields.keys()):
            value = getattr(self, field, None)
            printed_value = value if isinstance(value, list) else f'"{value}"'
            field_values.append(f'{field}={printed_value}')
        return 'TindRecord(' + ', '.join(field_values) + ')'


    def __eq__(self, other):
        if isinstance(other, type(self)):
            return self.__dict__ == other.__dict__
        return NotImplemented


    def __ne__(self, other):
        # Based on lengthy Stack Overflow answer by user "Maggyero" posted on
        # 2018-06-02 at https://stackoverflow.com/a/50661674/743730
        eq = self.__eq__(other)
        if eq is not NotImplemented:
            return not eq
        return NotImplemented


    def __lt__(self, other):
        return self.tind_id < other.tind_id


    def __gt__(self, other):
        if isinstance(other, type(self)):
            return other.tind_id < self.tind_id
        return NotImplemented


    def __le__(self, other):
        if isinstance(other, type(self)):
            return not other.tind_id < self.tind_id
        return NotImplemented


    def __ge__(self, other):
        if isinstance(other, type(self)):
            return not self.tind_id < other.tind_id
        return NotImplemented


    def _thumbnail_for_record(self, retry = 0):
        '''Return the URL for the thumbnail in TIND for this record.'''
        def response_handler(resp):
            if not resp:
                if __debug__: log(f'got empty json for thumbnail for {self.tind_id}')
                return ''
            try:
                data = json.loads(resp.text)
            except JSONDecodeError as ex:
                raise TindError(f'Malformed result from {self._server_url}: str(ex)')
            except TypeError as ex:
                raise DataMismatchError(f'Unexpected data returned by {self._server_url}.')

            if 'big' in data:
                if __debug__: log(f'thumbnail for {self.tind_id} is {data["big"]}')
                return data['big']
            elif 'medium' in data:
                if __debug__: log(f'thumbnail for {self.tind_id} is {data["medium"]}')
                return data['medium']
            elif 'small' in data:
                if __debug__: log(f'thumbnail for {self.tind_id} is {data["small"]}')
                return data['small']
            else:
                if __debug__: log(f'could not find thumbnail for {self.tind_id}')
                return ''

        endpoint = _THUMBNAIL_FOR_TIND_ID.format(self._server_url, self.tind_id)
        return result_from_api(endpoint, response_handler)
record.py: the TindRecord object class for Topi  Authors -------  <NAME> <<EMAIL>> -- Caltech Library  Copyright ---------  Copyright (c) 2021 by the California Institute of Technology.  This code is open-source software released under a 3-clause BSD license.  Please see the file "LICENSE" for more information. # Constants. # ............................................................................. # URL template for thumbnail images. The result is returned as JSON. # The first placeholder is for the host URL; the second is for a TIND record id. # Use Python .format() to substitute the relevant values into the string. # Class definitions. # ............................................................................. Object class for representing a record from TIND. # The reason for an explicit list of fields here is so that we can use it # in the definition of __repr__(). # Tind id == MARC control field 001 # Page for the record in TIND # MARC data field 245 # MARC data field 245 # MARC data field 245 or 100 # MARC data field 250 # MARC data field 260 # extracted from control field 008 # MARC data field 020 # MARC data field 300 concatenated # MARC data field 504a # Cover image shown on TIND record page # list of TindItem objects # Internal variables.  Need to set these first. # Always first initialize every field. # Set values if given arguments. # Based on lengthy Stack Overflow answer by user "Maggyero" posted on # 2018-06-02 at https://stackoverflow.com/a/50661674/743730 Return the URL for the thumbnail in TIND for this record.