From c7a6b0ed90ea059481894a505e66aec19cff559e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mike=20F=C3=A4hrmann?= <mike_faehrmann@web.de>
Date: Thu, 21 Mar 2019 14:46:47 +0100
Subject: [PATCH] [deviantart] add 'metadata' option (#189)

---
 docs/configuration.rst             | 11 +++++++++++
 gallery_dl/extractor/deviantart.py | 29 ++++++++++++++++++++++++++---
 2 files changed, 37 insertions(+), 3 deletions(-)

diff --git a/docs/configuration.rst b/docs/configuration.rst
index e43404a0..bc1fc392 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -437,6 +437,17 @@ Description Enable mature content.
 =========== =====
 
 
+extractor.deviantart.metadata
+-----------------------------
+=========== =====
+Type        ``bool``
+Default     ``false``
+Description Request extended metadata for deviation objects to additionally
+            provide ``description``, ``tags``, ``license`` and ``is_watching``
+            fields.
+=========== =====
+
+
 extractor.deviantart.original
 -----------------------------
 =========== =====
diff --git a/gallery_dl/extractor/deviantart.py b/gallery_dl/extractor/deviantart.py
index 7e0ddc58..4ee7c26b 100644
--- a/gallery_dl/extractor/deviantart.py
+++ b/gallery_dl/extractor/deviantart.py
@@ -563,7 +563,10 @@ class DeviantartPopularExtractor(DeviantartExtractor):
 
 
 class DeviantartAPI():
-    """Minimal interface for the deviantart API"""
+    """Minimal interface for the DeviantArt API
+
+    Ref: https://www.deviantart.com/developers/http/v1/20160316
+    """
     CLIENT_ID = "5388"
     CLIENT_SECRET = "76b08c69cfb27f26d6161f9ab6d061a1"
 
@@ -579,6 +582,7 @@ class DeviantartAPI():
         self.mature = extractor.config("mature", "true")
         if not isinstance(self.mature, str):
             self.mature = "true" if self.mature else "false"
+        self.metadata = extractor.config("metadata", False)
 
         self.refresh_token = extractor.config("refresh-token")
         self.client_id = extractor.config("client-id", self.CLIENT_ID)
@@ -619,7 +623,8 @@ class DeviantartAPI():
     def deviation(self, deviation_id):
         """Query and return info about a single Deviation"""
         endpoint = "deviation/" + deviation_id
-        return self._call(endpoint)
+        deviation = self._call(endpoint)
+        return self._extend((deviation,))[0]
 
     def deviation_content(self, deviation_id):
         """Get extended content of a single Deviation"""
@@ -633,6 +638,15 @@ class DeviantartAPI():
         params = {"mature_content": self.mature}
         return self._call(endpoint, params)
 
+    def deviation_metadata(self, deviations):
+        """ Fetch deviation metadata for a set of deviations"""
+        endpoint = "deviation/metadata?" + "&".join(
+            "deviationids[{}]={}".format(num, deviation["deviationid"])
+            for num, deviation in enumerate(deviations)
+        )
+        params = {"mature_content": self.mature}
+        return self._call(endpoint, params)["metadata"]
+
     def gallery(self, username, folder_id="", offset=0):
         """Yield all Deviation-objects contained in a gallery folder"""
         endpoint = "gallery/" + folder_id
@@ -737,7 +751,7 @@ class DeviantartAPI():
                 self.log.debug("Switching to private access token")
                 public = False
                 continue
-            yield from data["results"]
+            yield from self._extend(data["results"])
             if not data["has_more"]:
                 return
             params["offset"] = data["next_offset"]
@@ -747,6 +761,15 @@ class DeviantartAPI():
         result.extend(self._pagination(endpoint, params))
         return result
 
+    def _extend(self, deviations):
+        """Add extended metadata to a list of deviation objects"""
+        if self.metadata:
+            for deviation, metadata in zip(
+                    deviations, self.deviation_metadata(deviations)):
+                deviation.update(metadata)
+                deviation["tags"] = [t["tag_name"] for t in deviation["tags"]]
+        return deviations
+
 
 @cache(maxage=10*365*24*3600, keyarg=0)
 def _refresh_token_cache(original_token, new_token=None):