added as_dict() method to all objects

#8
jmolinski · Jun 27, 2016 · 702cde7 · 702cde7
1 parent 79f6610
commit 702cde7
Show file tree

Hide file tree

Showing 12 changed files with 129 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -66,6 +66,7 @@ title: str
 author: str
 views: int
 thumbnail: str
+as_dict() -> dict
 ```
 
 ---
@@ -81,6 +82,7 @@ name: str
 videos_amount: int
 subscriptions: int
 thumbnail: str
+as_dict() -> dict
 ```
 
 ---
@@ -98,6 +100,7 @@ thumbnail: str
 author: str
 first_video_id: str
 first_video_url: str
+as_dict() -> dict
 ```
 
 ---
@@ -117,6 +120,7 @@ views: int
 thumbnail: str
 next_video: VideoSignature
 related_videos: Tuple of VideoSignature
+as_dict() -> dict
 ```
 
 ---
@@ -133,6 +137,7 @@ author: str
 length: str
 thumbnail: str
 videos: Tuple of VideoSignature
+as_dict() -> dict
 ```
 
 ---

diff --git a/setup.py b/setup.py
@@ -5,10 +5,10 @@
 
 setup(
     name='openytapi',
-    version='2.0.0',
+    version='2.1.0',
     description='Open YouTube API library',
     url='https://github.com/Glenpl/openytapi',
-    download_url='https://github.com/Glenpl/openytapi/tarball/2.0.0',
+    download_url='https://github.com/Glenpl/openytapi/tarball/2.1.0',
     author='Glenpl/Jakub Molinski',
     author_email='kubamolinski@gmail.com',
     license='MIT',

diff --git a/tests/testchannelsignature.py b/tests/testchannelsignature.py
@@ -17,3 +17,14 @@ def test_getters(self):
         self.assertEqual(signature.subscriptions, 3555)
         self.assertEqual(signature.thumbnail, 'thumb')
         self.assertEqual(signature.name, 'name')
+
+    def test_as_dict(self):
+        signature = ChannelSignature('UCAw23LRxypuNn0ilUu1o1Cw', 'name', 11, 3555, 'thumb')
+        self.assertEqual(signature.as_dict(), {
+                'id': 'UCAw23LRxypuNn0ilUu1o1Cw',
+                'name': 'name',
+                'videos_amount': 11,
+                'subscriptions': 3555,
+                'url': 'https://www.youtube.com/channel/UCAw23LRxypuNn0ilUu1o1Cw',
+                'thumbnail': 'thumb'
+        })
diff --git a/tests/testplaylist.py b/tests/testplaylist.py
@@ -52,3 +52,15 @@ def test_youtubeplaylist_constructor(self):
     def test_real_get_video_invalid_id(self):
         self.assertRaises(YoutubeInvalidIdError,
                           lambda: YoutubeApi(nocache=True).get_playlist('hdsvhbdhdsvhhdsv'))
+
+    def test_as_dict(self):
+        def test_api_get_playlist(self):
+            html_code = read_in_file('tests/htmls/playlist_sample_source.txt')
+            playlist = YoutubeApi(http_fetcher=FakeFetcher(html_code), nocache=True).get_playlist(
+                                            'PLLUYFDT7vPkqBZQsTGBpGCjIoePETnOxi')
+
+            keys_playlist = ['videos', 'id', 'name', 'author', 'length', 'url', 'thumbnail']
+            self.assertTrue(all(x in playlist.as_dict() for x in keys_playlist))
+            keys_video = ['id', 'title', 'author', 'length', 'url', 'thumbnail', 'views']
+            for video in playlist.as_dict()['videos']:
+                self.assertTrue(all(x in video for x in keys_video))
diff --git a/tests/testplaylistsignature.py b/tests/testplaylistsignature.py
@@ -29,3 +29,17 @@ def test_getters(self):
         self.assertEqual(signature.thumbnail, 'thumb')
         self.assertEqual(signature.name, 'name')
         self.assertEqual(signature.first_video_id, 'nVjsGKrE6E8')
+
+    def test_as_dict(self):
+        signature = PlaylistSignature('PLLUYFDT7vPkqBZQsTGBpGCjIoePETnOxi',
+                                'name', 11, 'author', 'thumb', 'nVjsGKrE6E8')
+        self.assertEqual(signature.as_dict(), {
+                'id': 'PLLUYFDT7vPkqBZQsTGBpGCjIoePETnOxi',
+                'name': 'name',
+                'author': 'author',
+                'first_video_url': signature.first_video_url,
+                'first_video_id': 'nVjsGKrE6E8',
+                'length': 11,
+                'url': signature.url,
+                'thumbnail': signature.thumbnail
+        })
diff --git a/tests/testvideo.py b/tests/testvideo.py
@@ -51,3 +51,18 @@ def test_real_get_video_invalid_fetcher(self):
                           lambda: YoutubeApi(
                                     http_fetcher=ExceptionRaisingFetcher(),
                                     nocache=True).get_video('nVjsGKrE6E8'))
+
+    def test_as_dict(self):
+        html_code = read_in_file('tests/htmls/video_sample_source.txt')
+        video = YoutubeApi(http_fetcher=FakeFetcher(html_code), nocache=True).get_video('nVjsGKrE6E8')
+        keys_video = []
+
+        keys_video = ['id', 'title', 'author', 'length', 'url', 'thumbnail', 'views',
+                      'length_in_seconds', 'next_video', 'related_videos']
+        self.assertTrue(all(x in video.as_dict() for x in keys_video))
+
+        keys_videosignature = ['id', 'title', 'author', 'length', 'url', 'thumbnail', 'views']
+        self.assertTrue(all(x in video.as_dict()['next_video'] for x in keys_videosignature))
+
+        for video in video.as_dict()['related_videos']:
+            self.assertTrue(all(x in video for x in keys_videosignature))
diff --git a/tests/testvideosignature.py b/tests/testvideosignature.py
@@ -9,3 +9,15 @@ def test_videosignature_constructor(self):
     def test_get_video_url(self):
         signature = VideoSignature('TdrL3QxjyVw', ' ', ' ', 0, ' ')
         self.assertEqual(signature.url, 'https://www.youtube.com/watch?v=TdrL3QxjyVw')
+
+    def test_as_dict(self):
+        signature = VideoSignature('TdrL3QxjyVw', 'a', 'b', 0, 'c')
+        self.assertEqual(signature.as_dict(), {
+                'id': 'TdrL3QxjyVw',
+                'title': 'a',
+                'author': 'b',
+                'views': 0,
+                'length': 'c',
+                'url': 'https://www.youtube.com/watch?v=TdrL3QxjyVw',
+                'thumbnail': 'https://i.ytimg.com/vi/TdrL3QxjyVw/mqdefault.jpg'
+        })
diff --git a/youtube/channelsignature.py b/youtube/channelsignature.py
@@ -13,3 +13,13 @@ def url(self):
             return 'https://www.youtube.com/channel/' + self.channel_id
         else:
             return 'https://www.youtube.com/user/' + self.channel_id
+
+    def as_dict(self):
+        return {
+            'id': self.channel_id,
+            'name': self.name,
+            'videos_amount': self.videos_amount,
+            'subscriptions': self.subscriptions,
+            'url': self.url,
+            'thumbnail': self.thumbnail
+        }
diff --git a/youtube/playlist.py b/youtube/playlist.py
@@ -44,3 +44,14 @@ def url(self):
     @property
     def videos(self):
         return self._videos[:]
+
+    def as_dict(self):
+        return {
+            'id': self.playlist_id,
+            'name': self.name,
+            'author': self.author,
+            'length': self.length,
+            'url': self.url,
+            'thumbnail': self.thumbnail,
+            'videos': [video.as_dict() for video in self.videos]
+        }
diff --git a/youtube/playlistsignature.py b/youtube/playlistsignature.py
@@ -15,3 +15,15 @@ def url(self):
     @property
     def first_video_url(self):
         return 'https://www.youtube.com/watch?v={0}&list={1}'.format(self.first_video_id, self.playlist_id)
+
+    def as_dict(self):
+        return {
+            'id': self.playlist_id,
+            'name': self.name,
+            'author': self.author,
+            'first_video_url': self.first_video_url,
+            'first_video_id': self.first_video_id,
+            'length': self.length,
+            'url': self.url,
+            'thumbnail': self.thumbnail
+        }
diff --git a/youtube/video.py b/youtube/video.py
@@ -60,3 +60,17 @@ def related_videos(self):
     @property
     def thumbnail(self):
         return self._signature.thumbnail
+
+    def as_dict(self):
+        return {
+            'id': self.video_id,
+            'title': self.title,
+            'author': self.author,
+            'views': self.views,
+            'length': self.length,
+            'length_in_seconds': self.length_in_seconds,
+            'url': self.url,
+            'thumbnail': self.thumbnail,
+            'next_video': self.next_video.as_dict(),
+            'related_videos': [video.as_dict() for video in self.related_videos]
+        }
diff --git a/youtube/videosignature.py b/youtube/videosignature.py
@@ -14,3 +14,14 @@ def url(self):
     @property
     def thumbnail(self):
         return "https://i.ytimg.com/vi/{}/mqdefault.jpg".format(self.video_id)
+
+    def as_dict(self):
+        return {
+            'id': self.video_id,
+            'title': self.title,
+            'author': self.author,
+            'views': self.views,
+            'length': self.length,
+            'url': self.url,
+            'thumbnail': self.thumbnail
+        }