ocp5/populate.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""
Author: freezed <freezed@users.noreply.github.com> 2018-07-24
Version: 0.1
Licence: `GNU GPL v3` GNU GPL v3: http://www.gnu.org/licenses/

Call OpenFF API to populate a local MariaDB/MySQL database with product data
This DB will serve an CLI client which gives alternative products with better
nurition grade.
"""
import json
import requests
from config import FIELD_KEPT


def get_product(code):
    """
    Call OpenFF API to get data of a single product

    :Tests:
    >>> prod_beurre = get_product('3017760000109')
    >>> print(prod_beurre['product_name'])
    Le Véritable Petit Beurre

    >>> print(prod_beurre['stores'])
    Super U

    >>> print(prod_beurre['nutrition_grades'])
    e

    >>> print(prod_beurre['categories_tags'])
    ['en:sugary-snacks', 'en:biscuits-and-cakes', 'en:biscuits', 'fr:petits-beurres']

    >>> prod_oreo = get_product('8410000810004')
    >>> print(prod_oreo['code'])
    8410000810004

    >>> print(prod_oreo['product_name'])
    Biscuit Oreo

    >>> print(prod_oreo['stores'])
    Cora,Irma.dk,Leader Price

    >>> print(prod_oreo['nutrition_grades'])
    e

    >>> print(prod_oreo['categories_tags'])
    ['en:sugary-snacks', 'en:biscuits-and-cakes', 'en:biscuits', 'en:chocolate-biscuits', 'es:sandwich-cookies']

    >>> prod_false = get_product('1664')
    >>> prod_false is False
    True

    >>> prod_string = get_product('string')
    >>> prod_string is False
    True
    """

    try:
        int(code)

    except ValueError:  # as except_detail:
        # print("Exception: «{}»".format(except_detail))
        return False

    else:
        response = requests.get(
            "https://fr.openfoodfacts.org/api/v0/product/{}.json".format(code)
        )
        product_json = json.loads(response.text)

        if product_json['status'] and response.status_code == 200:
            product_kept = {'code': code}

            for field in FIELD_KEPT:
                product_kept[field] = product_json['product'][field]

            return product_kept

        else:
            return False


def get_category(name, from_file=False):
    """
    Call OpenFF API to get data of products in a single category

    First try, TODO :
    - work offline
    - need to get all the products of a category
    - need to keep more fields from a category than from a product, maybe
        FIELD_KEPT should be turned into a dict like this :
        {'category':[fields, …], 'products':[fields, …]}

    :Tests:
    # >>> prod_bisc = get_category('biscuits')
    >>> prod_bisc = get_category('biscuits', True)
    >>> 'count' in prod_bisc
    True

    >>> prod_false = get_category('1664')
    >>> prod_false
    False

    >>> 'stores' in prod_bisc['products'][0]
    True

    >>> 'product_name' in prod_bisc['products'][0]
    True

    >>> 'nutrition_grades' in prod_bisc['products'][0]
    True

    >>> 'categories_tags' in prod_bisc['products'][0]
    True

    # >>> 'countries' in prod_bisc['products'][0]
    # True

    # >>> 'id' in prod_bisc['products'][0]
    # True

    >>> get_category('wrong_file', True)
    File load error : sample-category-wrong_file.json
    False
    """

    if from_file:
        from os import path

        filename = 'sample-category-{}.json'.format(str(name))
        # File did not exists
        if path.isfile(filename) is False:
            print("File load error : {}".format(filename))
            status = False
            category_json = {'count': 0}

        else:
            with open(filename, "r") as json_file:
                category_json = json.loads(json_file.read())
                status = 200
    else:
        response = requests.get(
            "https://fr.openfoodfacts.org/category/{}.json".format(str(name))
        )
        category_json = json.loads(response.text)
        status = response.status_code

    if category_json['count'] is not 0 and status == 200:
        category_kept = {
            'count': category_json['count'],
            'products': [{}]
            }

        for field in FIELD_KEPT:
            category_kept['products'][0][field] = category_json['products'][0][field]

        return category_kept

    else:
        return False


if __name__ == "__main__":
    """ Starting doctests """

    import doctest
    doctest.testmod()