prepare for release:
* diffrent web directory with all web specific content (split doc dir -> doc (data) and web (rendered data))
* update installation
class Offer():
"""One Offer for sending.
This class is used to send a message via a provider.
"""
def __init__(self, name, provider, route, typ):
""" Constructor for Offer class.
:param string name: name is the name in database for the offer
:param `iro.offer.provider.Provider` provider: A valid provider object.
:param sting route: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`.
:param sting typ: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`.
.. automethod:: __call__
.. automethod:: __eq__
.. automethod:: __neq__
.. automethod:: __repr__
"""
self.name = name
self.route = route
self.provider = provider
self.typ = typ
self.sendfunc = provider.getSendFunc(typ, route)
def __call__(self, recipient, message):
"""send a message to a recipient. This method uses :meth:`iro.offer.provider.Provider.send`
:param recipient: one recipient
:param `iro.model.message.Message` message: message to send
"""
return self.sendfunc(recipient, message)
def __eq__(self,o):
"""return ``True``, if o is equal."""
return (self.name == o.name) and (self.route == o.route) and (self.provider == o.provider) and (self.typ == o.typ)
def __neq__(self,o):
"""return ``True``, if ``o`` is not equal (see :meth:`__eq__`)."""
return not self.__eq__(o)
def __repr__(self):
"""string representation of this class for debugging purpose.
:return: ``<Offer(name, provider, route, typ)>`` """
return "<Offer(%s, %s, %s, %s)>"%(self.name,self.provider,self.route,self.typ)