Create downloadable class

Author: seignovert

opus/images.py

@@ -1,9 +1,12 @@
 # -*- coding: utf-8 -*-
 
-from .wget import download
+from .data import DataDict
+from .wget import Downloadable
 
-class Image(object):
+
+class Image(Downloadable):
     def __init__(self, ring_obs_id, path, img):
+        Downloadable.__init__(self, path + img)
         self.ring_obs_id = ring_obs_id
         self.path = path
         self.img = img
@@ -14,18 +17,12 @@ def __repr__(self):
     def __str__(self):
         return self.ring_obs_id
 
-    @property
-    def url(self):
-        return self.path + self.img
-
-    def download(self, out=None):
-        download(self.url, out)
 
-class Images(object):
+class Images(DataDict):
     def __init__(self, json, size):
+        DataDict.__init__(self)
         self._json = json
         self.size = size
-        self._data = {}
         for img in json['data']:
             el = Image(img['ring_obs_id'], img['path'], img['img'])
             self._data[str(el)] = el
@@ -34,25 +31,6 @@ def __repr__(self):
         return 'OPUS API Images object (with {} {} images):\n'.format(len(self), self.size) + \
                '\n'.join(' - {}'.format(key) for key, _ in self.items())
 
-    def __len__(self):
-        return len(self._data)
-
-    def __getitem__(self, attr):
-        return self._data[attr]
-
-    def __iter__(self):
-        return iter(self._data)
-
-    def keys(self):
-        return self._data.keys()
-
-    def items(self):
-        return self._data.items()
-
-    def values(self):
-        return self._data.values()
-
-
     @property
     def order(self):
         return self._json['order']

opus/wget.py

@@ -3,22 +3,27 @@
 import requests
 import shutil
 
-def download(url, out=None):
-    outdir = None
-    if out and os.path.isdir(out):
-        outdir = out
-        out = None
 
-    if out is None:
-        filename = url.split('/')[-1]
-    else:
-        filename = out
+class Downloadable(object):
+    def __init__(self, url):
+        self.url = url
 
-    if outdir:
-        filename = os.path.join(outdir, filename)
+    def download(self, out=None):
+        outdir = None
+        if out and os.path.isdir(out):
+            outdir = out
+            out = None
 
-    r = requests.get(url, stream=True)
-    with open(filename, 'wb') as f:
-        shutil.copyfileobj(r.raw, f)
+        if out is None:
+            filename = self.url.split('/')[-1]
+        else:
+            filename = out
 
-    return filename
+        if outdir:
+            filename = os.path.join(outdir, filename)
+
+        r = requests.get(self.url, stream=True)
+        with open(filename, 'wb') as f:
+            shutil.copyfileobj(r.raw, f)
+
+        return filename

tests/test_images.py

@@ -21,67 +21,21 @@ def image(size):
     json = JSON.loads(open('tests/api/image/'+size+'/'+ring_obs_id+'.json', 'r').read())
     return Image(ring_obs_id, json['path'], json['data'][0]['img'])
 
-def test_images_meta(images, size):
-    r = repr(images)
-    assert 'OPUS API Images object' in r
-    assert 'S_IMG_CO_ISS_1508094647_N' in r
-    assert len(images) == 10
-    assert images.order == 'obs_general.time1'
-    assert images.size == size
-    assert isinstance(images['S_IMG_CO_ISS_1508094647_N'], Image)
 
-def test_images_image(image):
+def test_image(image):
     assert repr(image) == 'OPUS API Image object: S_IMG_CO_ISS_1459551972_N'
     assert str(image) == 'S_IMG_CO_ISS_1459551972_N'
     assert image.ring_obs_id == 'S_IMG_CO_ISS_1459551972_N'
     assert image.path == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/'
     assert image.img == 'COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
     assert image.url == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
 
-def test_images_iter(images):
-    for key in images:
-        assert key in images.keys()
-        break
-    for value in images.values():
-        assert isinstance(value, Image)
-        break
-
-
-@responses.activate
-def test_image_download(image):
-    fname = os.path.basename(image.url)
-
-    with open('tests/api/image/med/'+fname, 'rb') as img:
-        responses.add(responses.GET, image.url,
-                    body=img.read(), status=200,
-                    content_type='image/jpeg',
-                    stream=True
-        )
-
-    image.download(out='tests/')
-
-    assert len(responses.calls) == 1
-    assert responses.calls[0].request.url == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
 
-    assert os.path.isfile('tests/'+fname)
-    os.remove('tests/'+fname)
-
-
-@responses.activate
-def test_image_download_output(image):
-    fname = os.path.basename(image.url)
-
-    with open('tests/api/image/med/'+fname, 'rb') as img:
-        responses.add(responses.GET, image.url,
-                      body=img.read(), status=200,
-                      content_type='image/jpeg',
-                      stream=True
-                      )
-
-    image.download(out='tests/test.jpg')
-
-    assert len(responses.calls) == 1
-    assert responses.calls[0].request.url == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
+def test_images_meta(images, size):
+    r = repr(images)
+    assert 'OPUS API Images object' in r
+    assert 'S_IMG_CO_ISS_1508094647_N' in r
+    assert len(images) == 10
+    assert images.order == 'obs_general.time1'
+    assert images.size == size
 
-    assert os.path.isfile('tests/test.jpg')
-    os.remove('tests/test.jpg')

tests/test_wget.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+import pytest
+import os
+import responses
+
+from opus.wget import Downloadable
+
+
+@pytest.fixture
+def url():
+    return 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
+
+@pytest.fixture
+def downloadable(url):
+    return Downloadable(url)
+
+@responses.activate
+def test_image_download(downloadable):
+    fname = 'N1459551972_1_med.jpg'
+    with open('tests/api/image/med/'+fname, 'rb') as img:
+        responses.add(responses.GET, downloadable.url,
+                      body=img.read(), status=200,
+                      content_type='image/jpeg',
+                      stream=True
+                      )
+
+    downloadable.download(out='tests/')
+
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == downloadable.url
+
+    assert os.path.isfile('tests/'+fname)
+    os.remove('tests/'+fname)
+
+
+@responses.activate
+def test_image_download_output(downloadable):
+    fname = 'N1459551972_1_med.jpg'
+    with open('tests/api/image/med/'+fname, 'rb') as img:
+        responses.add(responses.GET, downloadable.url,
+                      body=img.read(), status=200,
+                      content_type='image/jpeg',
+                      stream=True
+                      )
+
+    downloadable.download(out='tests/test.jpg')
+
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == downloadable.url
+
+    assert os.path.isfile('tests/test.jpg')
+    os.remove('tests/test.jpg')