Merge pull request #8 from jyksnw/development

Merge for release of version 0.1.1

Author: Jason Snow

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup
 
-VERSION = '0.1.0'
+VERSION = '0.1.1'
 
 
 def read(file_name):

tests/test_youversion.py

@@ -241,3 +241,14 @@ def test_get_verse_of_the_day_contains_image(self):
             raise AssertionError()
         if votd.image._url is None or votd.image._url == '':
             raise AssertionError()
+
+    def test_get_all_verse_of_the_days(self):
+        more_data, size, votds = self.client.get_all_verse_of_the_days()
+        if more_data:
+            # Should have received all data
+            raise AssertionError()
+        if size < 365 or size > 366:
+            # Should be 365 or 366 responses
+            raise AssertionError()
+        if votds is None or len(votds) != size:
+            raise AssertionError()

youversion/youversion.py

@@ -1,4 +1,4 @@
-from typing import Dict, TypeVar, Optional
+from typing import Dict, TypeVar, Optional, List, Tuple
 from datetime import datetime
 from os import path, getcwd
 from shutil import copyfileobj
@@ -407,3 +407,24 @@ def get_verse_of_the_day(self, day: int = current_day_of_year()) -> VerseOfTheDa
                 }
             )
         )
+
+    def get_all_verse_of_the_days(self, limit: int = 366, page: int = 1) -> Tuple[bool, int, Optional[List[VerseOfTheDay]]]:
+        """
+        Gets multiple verse of the day objects
+
+        :param limit: Currently not used (see issue: https://github.com/lifechurch/youversion-public-api-docs/issues/7)
+        :param page: Currently not used (see issue: https://github.com/lifechurch/youversion-public-api-docs/issues/7)
+        :return: tuple[bool, int, list of VerseOfTheDay].
+            bool indicates if another page is available, if results are paginated
+            int the number of VerseOfTheDay objects contained in the response
+            list of VerseOfTheDay objects
+        """
+        json = self._get('verse_of_the_day', params={'version_id': self.bible_version.id})
+        if not json or 'data' not in json:
+            return False, 0, None
+
+        votds = [VerseOfTheDay(bible_version=self.bible_version, json=data) for data in json.get('data', [])]
+        next_page = json.get('next_page', False)
+        page_size = json.get('page_size', len(votds))
+
+        return next_page, page_size, votds