creation of ICapJob : capability that manage jod adverts

weboob/capabilities/job.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2010-2013 Bezleputh
+#
+# 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 CapBaseObject, IBaseCap, StringField, DateField
+
+__all__ = ['BaseJobAdvert', 'ICapJob']
+
+
+class BaseJobAdvert(CapBaseObject):
+    """
+    Represents a job announce.
+    """
+    url =              StringField('URL of the announce')
+    publication_date = DateField('Date when the announce has been published')
+    society_name =     StringField('Name of the society taht published the announce')
+    place =            StringField('Place where the job take place')
+    job_name =         StringField('Name of the job')
+    title =            StringField('Title of the announce')
+    contract_type =    StringField('Type of the contrat : CDI, CDD')
+    pay =              StringField('Amount of the salary')
+    description =      StringField('Description of the job')
+    formation =        StringField('Required formation')
+    experience =       StringField('Required experience')
+
+    def __unicode__(self):
+        message = u'\r\n-- Advert --\r\n'
+        message += u'id : %s\r\n' % self.id
+        message += u'url : %s\r\n' % self.url
+        message += u'publication_date : %s\r\n' % self.publication_date
+        message += u'society_name : %s\r\n' % self.society_name
+        message += u'place : %s\r\n' % self.place
+        message += u'job_name : %s\r\n' % self.job_name
+        message += u'title : %s\r\n' % self.title
+        message += u'contract_type : %s\r\n' % self.contract_type
+        message += u'pay : %s\r\n' % self.pay
+        message += u'description : %s\r\n' % self.description
+        message += u'formation : %s\r\n' % self.formation
+        message += u'experience : %s\r\n' % self.experience
+        return message
+
+    def __repr__(self):
+        return self.__unicode__()
+
+    @classmethod
+    def id2url(cls, _id):
+        """Overloaded in child classes provided by backends."""
+        raise NotImplementedError()
+
+    @property
+    def page_url(self):
+        """
+        Get page URL of the announce.
+        """
+        return self.id2url(self.id)
+
+
+class ICapJob(IBaseCap):
+    """
+    Capability of job annouce websites.
+    """
+    def search_job(self, pattern=None):
+        """
+        Iter results of a search on a pattern.
+
+        :param pattern: pattern to search on
+        :type pattern: str
+        :rtype: iter[:class:`BaseJobAdvert`]
+        """
+        raise NotImplementedError()
+
+    def get_job_advert(self, _id, advert=None):
+        """
+        Get an announce from an ID.
+
+        :param _id: id of the advert
+        :type _id: str
+        :param advert : the advert
+        :type advert : BaseJobAdvert
+        :rtype: :class:`BaseJobAdvert` or None is fot found.
+        """
+        raise NotImplementedError()