115 lines
4.1 KiB
Python
115 lines
4.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright(C) 2013 Julien Veyssier
|
|
#
|
|
# This file is part of weboob.
|
|
#
|
|
# weboob is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# weboob is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with weboob. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
from .base import IBaseCap, CapBaseObject, StringField, IntField, Field, empty
|
|
import xml.etree.ElementTree as ET
|
|
|
|
|
|
__all__ = ['Recipe', 'ICapRecipe']
|
|
|
|
|
|
class Recipe(CapBaseObject):
|
|
"""
|
|
Recipe object.
|
|
"""
|
|
title = StringField('Title of the recipe')
|
|
thumbnail_url = StringField('Direct url to recipe thumbnail')
|
|
picture_url = StringField('Direct url to recipe picture')
|
|
short_description = StringField('Short description of a recipe')
|
|
nb_person = IntField('The recipe was made for this amount of persons')
|
|
preparation_time = IntField('Preparation time of the recipe in minutes')
|
|
cooking_time = IntField('Cooking time of the recipe in minutes')
|
|
ingredients = Field('Ingredient list necessary for the recipe',list)
|
|
instructions = StringField('Instruction step list of the recipe')
|
|
comments = Field('User comments about the recipe',list)
|
|
|
|
def __init__(self, id, title):
|
|
CapBaseObject.__init__(self, id)
|
|
self.title = title
|
|
|
|
def toKrecipesXml(self, author=None):
|
|
"""
|
|
Export recipe to KRecipes XML string
|
|
"""
|
|
if author == None:
|
|
author = 'Cookboob'
|
|
initial_xml = '''\
|
|
<krecipes version='2.0-beta2' lang='fr' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:noNamespaceSchemaLocation='krecipes.xsd'>
|
|
<krecipes-recipe id='1'>
|
|
</krecipes-recipe>
|
|
</krecipes>'''
|
|
doc = ET.fromstring(initial_xml)
|
|
recipe = doc.find('krecipes-recipe')
|
|
desc = ET.SubElement(recipe, 'krecipes-description')
|
|
title = ET.SubElement(desc, 'title')
|
|
title.text = self.title
|
|
authors = ET.SubElement(desc, 'author')
|
|
authors.text = author
|
|
eyield = ET.SubElement(desc, 'yield')
|
|
if not empty(self.nb_person):
|
|
amount = ET.SubElement(eyield, 'amount')
|
|
amount.text = '%s' % self.nb_person
|
|
etype = ET.SubElement(eyield, 'type')
|
|
etype.text = 'persons'
|
|
if not empty(self.preparation_time):
|
|
preptime = ET.SubElement(desc, 'preparation-time')
|
|
preptime.text = '%02d:%02d' % (self.preparation_time / 60, self.preparation_time % 60)
|
|
|
|
if not empty(self.ingredients):
|
|
ings = ET.SubElement(recipe, 'krecipes-ingredients')
|
|
for i in self.ingredients:
|
|
ing = ET.SubElement(ings, 'ingredient')
|
|
am = ET.SubElement(ing, 'amount')
|
|
am.text = ''
|
|
unit = ET.SubElement(ing, 'unit')
|
|
unit.text = ''
|
|
name = ET.SubElement(ing, 'name')
|
|
name.text = '%s' % i
|
|
|
|
if not empty(self.instructions):
|
|
instructions = ET.SubElement(recipe, 'krecipes-instructions')
|
|
instructions.text = self.instructions
|
|
|
|
return ET.tostring(doc, encoding='UTF-8').decode('utf-8')
|
|
|
|
|
|
class ICapRecipe(IBaseCap):
|
|
"""
|
|
Recipe providers.
|
|
"""
|
|
def iter_recipes(self, pattern):
|
|
"""
|
|
Search recipes and iterate on results.
|
|
|
|
:param pattern: pattern to search
|
|
:type pattern: str
|
|
:rtype: iter[:class:`Recipe`]
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def get_recipe(self, _id):
|
|
"""
|
|
Get a recipe object from an ID.
|
|
|
|
:param _id: ID of recipe
|
|
:type _id: str
|
|
:rtype: :class:`Recipe`
|
|
"""
|
|
raise NotImplementedError()
|