new capability ICapAudioStream

for web site providing audio streams

Signed-off-by: Pierre Mazière <pierre.maziere@gmx.com>

weboob/capabilities/audiostream.py

@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+
+# Copyright(C) 2013 Pierre Mazière
+#
+# 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 datetime import timedelta
+
+from .base import IBaseCap, CapBaseObject, Field, StringField
+from .file import ICapFile
+from .audio import ICapAudio, BaseAudio
+
+
+__all__ = ['AudioStreamInfo','BaseAudioStream','ICapAudioStream']
+
+class AudioStreamInfo(CapBaseObject):
+    """
+    AudioStream related information.
+    """
+    who =    StringField('Who is currently on air')
+    what =     StringField('What is currently on air')
+
+    def __iscomplete__(self):
+        # This volatile information may be reloaded everytimes.
+        return False
+
+    def __unicode__(self):
+        if self.who:
+            return u'%s - %s' % (self.who, self.what)
+        else:
+            return self.what
+
+
+class BaseAudioStream(BaseAudio):
+    """
+    Audio stream object
+    """
+    current = Field('Information related to current broadcast',AudioStreamInfo)
+
+    def __unicode__(self):
+        return u'%s (%s)' % (self.title, self.url)
+
+    def __repr__(self):
+        return self.__unicode__()
+
+class ICapAudioStream(ICapAudio):
+    """
+    Audio streams provider
+    """
+    def search_audiostreams(self, pattern, sortby=ICapFile.SEARCH_RELEVANCE):
+        """
+        Search an audio stream
+
+        :param pattern: pattern to search
+        :type pattern: str
+        :param sortby: sort by ... (use SEARCH_* constants)
+        :rtype: iter[:class:`BaseAudioStream`]
+        """
+        return self.search_audio(self,pattern,sortby)
+
+    def get_audiostream(self, id):
+        """
+        Get an audio stream
+
+        :param pattern: pattern to search on
+        :type id: str
+        :rtype: :class:`BaseAudioStream`
+        """
+        return self.get_audio(self, id)
+