iro/offer/offer.py
author Sandro Knauß <knauss@netzguerilla.net>
Fri, 24 Aug 2012 01:05:06 +0200
branchdevel
changeset 294 0e75bd39767d
parent 257 31114e40178d
permissions -rw-r--r--
adding LICENSE to all files
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
294
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     1
# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net>
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     2
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     3
# This file is part of Iro.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     4
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     5
# Permission is hereby granted, free of charge, to any person obtaining a copy of
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     6
# this software and associated documentation files (the "Software"), to deal in
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     7
# the Software without restriction, including without limitation the rights to use,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     8
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
     9
# #Software, and to permit persons to whom the Software is furnished to do so,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    10
# subject to the following conditions:
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    11
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    12
# The above copyright notice and this permission notice shall be included in
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    13
# all copies or substantial portions of the Software.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    14
# 
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    15
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    16
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    17
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    18
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    19
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    20
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0e75bd39767d adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents: 257
diff changeset
    21
142
7d0c1fa97123 task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
class Offer():
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    23
    """One Offer for sending.
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    24
    This class is used to send a message via a provider.
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    25
    """
157
0192f9107870 model.offer.loadOffers implemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 156
diff changeset
    26
    def __init__(self, name, provider, route, typ):
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    27
        """ Constructor for Offer class.
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    28
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    29
        :param string name: name is the name in database for the offer
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    30
        :param `iro.offer.provider.Provider` provider: A valid provider object.
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    31
        :param sting route: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`.
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    32
        :param sting typ: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`.
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    33
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    34
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    35
        .. automethod:: __call__
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    36
        .. automethod:: __eq__
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    37
        .. automethod:: __neq__
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    38
        .. automethod:: __repr__
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    39
        """
142
7d0c1fa97123 task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
        self.name = name
157
0192f9107870 model.offer.loadOffers implemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 156
diff changeset
    41
        self.route = route
0192f9107870 model.offer.loadOffers implemented
Sandro Knauß <knauss@netzguerilla.net>
parents: 156
diff changeset
    42
        self.provider = provider
159
fbd7364b252d implementing Provider.loadConig started
Sandro Knauß <knauss@netzguerilla.net>
parents: 157
diff changeset
    43
        self.typ = typ
161
072ee139eb67 sending part now in provoder class
Sandro Knauß <knauss@netzguerilla.net>
parents: 160
diff changeset
    44
        self.sendfunc = provider.getSendFunc(typ, route)
142
7d0c1fa97123 task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
161
072ee139eb67 sending part now in provoder class
Sandro Knauß <knauss@netzguerilla.net>
parents: 160
diff changeset
    46
    def __call__(self, recipient, message):
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    47
        """send a message to a recipient. This method uses :meth:`iro.offer.provider.Provider.send`
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    48
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    49
        :param recipient: one recipient
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    50
        :param `iro.model.message.Message` message: message to send
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    51
        """
161
072ee139eb67 sending part now in provoder class
Sandro Knauß <knauss@netzguerilla.net>
parents: 160
diff changeset
    52
        return self.sendfunc(recipient, message)
160
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    53
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    54
    def __eq__(self,o):
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    55
        """return ``True``, if o is equal."""
160
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    56
        return (self.name == o.name) and (self.route == o.route) and (self.provider == o.provider) and (self.typ == o.typ)
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    57
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    58
    def __neq__(self,o):
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    59
        """return ``True``, if ``o`` is not equal (see :meth:`__eq__`)."""
160
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    60
        return not self.__eq__(o)
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    61
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    62
    def __repr__(self):
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    63
        """string representation of this class for debugging purpose.
160
f4e4f4ba25fb passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents: 159
diff changeset
    64
257
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    65
        :return: ``<Offer(name, provider, route, typ)>`` """
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    66
        return "<Offer(%s, %s, %s, %s)>"%(self.name,self.provider,self.route,self.typ)
31114e40178d iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
    67