Add Session.series_list to list series

docs/index.rst

@@ -126,6 +126,13 @@ m.series(series_id)
 Calls the `/v1/public/series/{seriesId}` endpoint with the first
 argument and returns a `Series` object.
 
+m.series_list(params=None)
+.....................
+
+Calls the `/v1/public/series` endpoint with any params passed in and
+returns a `SeriesList` object. For documentation on `SeriesList`, see below. For
+documentation on all the params argument, see the
+`Marvel API documentation <https://developer.marvel.com/docs#!/public/getSeriesCollection_get_25>`_
 
 
 Objects
@@ -190,6 +197,12 @@ Series
 - ``comics`` - Method, Returns ``ComicsList`` object for `/v1/public/series/{seriesId}/comics`
 
 
+SeriesList
+..........
+
+- ``series`` - List, ``Series`` objects
+- ``response`` - Dictionary, raw response body
+
 
 Exceptions
 ----------

marvelous/series_list.py

@@ -0,0 +1,33 @@
+import itertools
+
+from marshmallow import ValidationError
+
+from . import exceptions, series
+
+
+class SeriesList():
+    def __init__(self, response):
+        self.series = []
+        self.response = response
+
+        schema = series.SeriesSchema()
+        for series_dict in response['data']['results']:
+            try:
+                result = schema.load(series_dict)
+            except ValidationError as error:
+                raise exceptions.ApiError(error)
+
+            self.series.append(result)
+
+    def __iter__(self):
+        return iter(self.series)
+
+    def __len__(self):
+        return len(self.series)
+
+    def __getitem__(self, index):
+        try:
+            return next(itertools.islice(self.series, index, index + 1))
+        except TypeError:
+            return list(itertools.islice(
+                self.series, index.start, index.stop, index.step))

marvelous/session.py

@@ -7,7 +7,7 @@
 
 from marshmallow import ValidationError
 
-from . import exceptions, comics_list, series
+from . import exceptions, comics_list, series, series_list
 
 
 class Session():
@@ -86,3 +86,10 @@ def series(self, _id):
 
         result.session = self
         return result
+
+    def series_list(self, params=None):
+        if params is None:
+            params = {}
+
+        return series_list.SeriesList(
+            self.call(['series'], params=params))

tests/series_test.py

@@ -31,5 +31,12 @@ def test_bad_response_data(self):
         with self.assertRaises(marvelous.exceptions.ApiError):
             ComicsList({'data': {'results': [{'modified': 'potato'}]}})
 
+    def test_pulls_verbose(self):
+        series = self.m.series_list({
+            'orderBy': 'modified',
+        })
+
+        self.assertGreater(len(series.series), 0)
+
 if __name__ == '__main__':
     unittest.main()