[dropbox] conform to BaseStorage interface (#1251)

storages/backends/dropbox.py

@@ -1,24 +1,14 @@
 # Dropbox storage class for Django pluggable storage system.
 # Author: Anthony Monthe <anthony.monthe@gmail.com>
 # License: BSD
-#
-# Usage:
-#
-# Add below to settings.py:
-# DROPBOX_ROOT_PATH = '/dir/'
-# DROPBOX_OAUTH2_TOKEN = 'YourOauthToken'
-# DROPBOX_APP_KEY = 'YourAppKey'
-# DROPBOX_APP_SECRET = 'YourAppSecret``
-# DROPBOX_OAUTH2_REFRESH_TOKEN = 'YourOauthRefreshToken'
-
 
+import warnings
 from io import BytesIO
 from shutil import copyfileobj
 from tempfile import SpooledTemporaryFile
 
 from django.core.exceptions import ImproperlyConfigured
 from django.core.files.base import File
-from django.core.files.storage import Storage
 from django.utils._os import safe_join
 from django.utils.deconstruct import deconstructible
 from dropbox import Dropbox
@@ -28,6 +18,7 @@
 from dropbox.files import UploadSessionCursor
 from dropbox.files import WriteMode
 
+from storages.base import BaseStorage
 from storages.utils import get_available_overwrite_name
 from storages.utils import setting
 
@@ -77,30 +68,15 @@ def _set_file(self, value):
 
 
 @deconstructible
-class DropboxStorage(Storage):
+class DropboxStorage(BaseStorage):
     """Dropbox Storage class for Django pluggable storage system."""
-    location = setting('DROPBOX_ROOT_PATH', '/')
-    oauth2_access_token = setting('DROPBOX_OAUTH2_TOKEN')
-    app_key = setting('DROPBOX_APP_KEY')
-    app_secret = setting('DROPBOX_APP_SECRET')
-    oauth2_refresh_token = setting('DROPBOX_OAUTH2_REFRESH_TOKEN')
-    timeout = setting('DROPBOX_TIMEOUT', _DEFAULT_TIMEOUT)
-    write_mode = setting('DROPBOX_WRITE_MODE', _DEFAULT_MODE)
-
     CHUNK_SIZE = 4 * 1024 * 1024
 
-    def __init__(
-        self,
-        oauth2_access_token=oauth2_access_token,
-        root_path=location,
-        timeout=timeout,
-        write_mode=write_mode,
-        app_key=app_key,
-        app_secret=app_secret,
-        oauth2_refresh_token=oauth2_refresh_token,
-    ):
-        if oauth2_access_token is None and not all(
-            [app_key, app_secret, oauth2_refresh_token]
+    def __init__(self, oauth2_access_token=None, **settings):
+        super().__init__(oauth2_access_token=oauth2_access_token, **settings)
+
+        if self.oauth2_access_token is None and not all(
+            [self.app_key, self.app_secret, self.oauth2_refresh_token]
         ):
             raise ImproperlyConfigured(
                 "You must configure an auth token at"
@@ -109,16 +85,32 @@ def __init__(
                 "'setting.DROPBOX_APP_SECRET' "
                 "and 'setting.DROPBOX_OAUTH2_REFRESH_TOKEN'."
             )
-        self.root_path = root_path
-        self.write_mode = write_mode
         self.client = Dropbox(
-            oauth2_access_token,
-            app_key=app_key,
-            app_secret=app_secret,
-            oauth2_refresh_token=oauth2_refresh_token,
-            timeout=timeout,
+            self.oauth2_access_token,
+            app_key=self.app_key,
+            app_secret=self.app_secret,
+            oauth2_refresh_token=self.oauth2_refresh_token,
+            timeout=self.timeout,
         )
 
+        # Backwards compat
+        if hasattr(self, 'location'):
+            warnings.warn(
+                "Setting `root_path` with name `location` is deprecated and will be removed in a future version of "
+                "django-storages. Please update the name from `location` to `root_path`", DeprecationWarning)
+            self.root_path = self.location
+
+    def get_default_settings(self):
+        return {
+            "root_path": setting('DROPBOX_ROOT_PATH', '/'),
+            "oauth2_access_token": setting('DROPBOX_OAUTH2_TOKEN'),
+            "app_key": setting('DROPBOX_APP_KEY'),
+            "app_secret": setting('DROPBOX_APP_SECRET'),
+            "oauth2_refresh_token": setting('DROPBOX_OAUTH2_REFRESH_TOKEN'),
+            "timeout":  setting('DROPBOX_TIMEOUT', _DEFAULT_TIMEOUT),
+            "write_mode": setting('DROPBOX_WRITE_MODE', _DEFAULT_MODE),
+        }
+
     def _full_path(self, name):
         if name == '/':
             name = ''