Merge nice changes from the PyDrive dev (#66)

* Added example: upload and auto-convert file from command line using command line auth.

Code contributed by github.com/yurtesen/

* Correctly handle uploads of empty files.

* Update default field list

* Update tox.ini to drop py26, install testing dependencies

* Support Optional Query Parameters in `InsertPermission()`

* Change "application type" to "other"

To address 400 failure

* Clarify underlying API version, closes #99

* update to Desktop app the application type

* Update to use web application for quick start

* minor: add newline

* update example to use pydrive2

* revert changes to setup.py

* revert empty file test

* revert empty uploads/downloads fix, fixed upstream

* revert to resumable uploads

* remove unused import

* Update tox.ini

* Update README.rst

* fix formatting

Co-authored-by: robin <[email protected]>
Co-authored-by: Steven Bazyl <[email protected]>
Co-authored-by: Ross Smith II <[email protected]>

Author: 4 people

README.rst

@@ -7,7 +7,7 @@ PyDrive2
 
 *PyDrive2* is a wrapper library of
 `google-api-python-client <https://github.com/google/google-api-python-client>`_
-that simplifies many common Google Drive API tasks. It is an actively
+that simplifies many common Google Drive API V2 tasks. It is an actively
 maintained fork of `https://pypi.python.org/pypi/PyDrive <https://pypi.python.org/pypi/PyDrive>`_.
 By the authors and maintainers of the `Git for Data <https://dvc.org>`_ - DVC
 project.
@@ -24,7 +24,7 @@ Features of PyDrive2
 --------------------
 
 -  Simplifies OAuth2.0 into just few lines with flexible settings.
--  Wraps `Google Drive API <https://developers.google.com/drive/>`_ into
+-  Wraps `Google Drive API V2 <https://developers.google.com/drive/v2/web/about-sdk>`_ into
    classes of each resource to make your program more object-oriented.
 -  Helps common operations else than API calls, such as content fetching
    and pagination control.

docs/quickstart.rst

@@ -12,9 +12,8 @@ Drive API requires OAuth2.0 for authentication. *PyDrive2* makes your life much
 
  a. Select 'Application type' to be *Web application*.
  b. Enter an appropriate name.
- c. Input *http://localhost:8080* for 'Authorized JavaScript origins'.
- d. Input *http://localhost:8080/* for 'Authorized redirect URIs'.
- e. Click 'Create'.
+ c. Input *http://localhost:8080/* for 'Authorized redirect URIs'.
+ d. Click 'Create'.
 
 5. Click 'Download JSON' on the right side of Client ID to download **client_secret_<really long ID>.json**.
 

examples/Upload-and-autoconvert-to-Google-Drive-Format-Example/README

@@ -0,0 +1,15 @@
+This script uploads a file to a folder on Google Drive. If the file can be
+converted into the Google format, such as a Google Sheet, it will be converted.
+
+To run the script you need to complete the following steps:
+1. Update settings.yaml with your:
+   - client ID,
+   - client secret, and
+   - credential storage path
+2. Update upload.py with the location you save your settings.yaml file. This
+   can be an absolute or relative path.
+
+
+This example is adapted from Evren Yurtesen (https://github.com/yurtesen/)
+with his consent.
+Originally posted here: https://github.com/prasmussen/gdrive/issues/154

examples/Upload-and-autoconvert-to-Google-Drive-Format-Example/settings.yaml

@@ -0,0 +1,19 @@
+# Original author: Evren Yurtesen - https://github.com/yurtesen/
+
+client_config_backend: settings
+client_config:
+  client_id: <INSERT YOUR CLIENT_ID HERE>
+  client_secret: <INSERT YOUR SECRET HERE>
+  auth_uri: https://accounts.google.com/o/oauth2/auth
+  token_uri: https://accounts.google.com/o/oauth2/token
+  redirect_uri: urn:ietf:wg:oauth:2.0:oob
+  revoke_uri:
+
+save_credentials: True
+save_credentials_backend: file
+save_credentials_file: <STORAGE PATH, e.g. /usr/local/scripts/pydrive/credentials.json>
+
+get_refresh_token: True
+
+oauth_scope:
+  - https://www.googleapis.com/auth/drive.file

examples/Upload-and-autoconvert-to-Google-Drive-Format-Example/upload.py

@@ -0,0 +1,58 @@
+# Original author: Evren Yurtesen - https://github.com/yurtesen/
+
+"""
+Uploads a file to a specific folder in Google Drive and converts it to a
+Google Doc/Sheet/etc. if possible.
+
+usage: upload.py <Google Drive folder ID> <local file path>
+example usage: upload.py 0B5XXXXY9KddXXXXXXXA2c3ZXXXX /path/to/my/file
+"""
+import sys
+from os import path
+from pydrive2.auth import GoogleAuth
+from pydrive2.drive import GoogleDrive
+from pydrive2.settings import LoadSettingsFile
+
+# Update this value to the correct location.
+#   e.g. "/usr/local/scripts/pydrive/settings.yaml"
+PATH_TO_SETTINGS_FILE = None
+assert PATH_TO_SETTINGS_FILE is not None  # Fail if path not specified.
+
+gauth = GoogleAuth()
+gauth.settings = LoadSettingsFile(filename=PATH_TO_SETTINGS_FILE)
+gauth.CommandLineAuth()
+drive = GoogleDrive(gauth)
+
+# If provided arguments incorrect, print usage instructions and exit.
+if len(sys.argv) < 2:
+    print("usage: upload.py <Google Drive folder ID> <local file path>")
+    exit(1)  # Exit program as incorrect parameters provided.
+
+parentId = sys.argv[1]
+myFilePath = sys.argv[2]
+myFileName = path.basename(sys.argv[2])
+
+# Check if file name already exists in folder.
+file_list = drive.ListFile(
+    {
+        "q": '"{}" in parents and title="{}" and trashed=false'.format(
+            parentId, myFileName
+        )
+    }
+).GetList()
+
+# If file is found, update it, otherwise create new file.
+if len(file_list) == 1:
+    myFile = file_list[0]
+else:
+    myFile = drive.CreateFile(
+        {"parents": [{"kind": "drive#fileLink", "id": parentId}]}
+    )
+
+# Upload new file content.
+myFile.SetContentFile(myFilePath)
+myFile["title"] = myFileName
+# The `convert` flag indicates to Google Drive whether to convert the
+# uploaded file into a Google Drive native format, i.e. Google Sheet for
+# CSV or Google Document for DOCX.
+myFile.Upload({"convert": True})

pydrive2/files.py

@@ -211,20 +211,22 @@ def __init__(self, auth=None, metadata=None, uploaded=False):
             self.update(metadata)
         self._ALL_FIELDS = (
             "alternateLink,appDataContents,"
-            "canComment,canReadRevisions,"
+            "canComment,canReadRevisions,capabilities"
             "copyable,createdDate,defaultOpenWithLink,description,"
             "downloadUrl,editable,embedLink,etag,explicitlyTrashed,"
             "exportLinks,fileExtension,fileSize,folderColorRgb,"
-            "fullFileExtension,headRevisionId,iconLink,id,"
+            "fullFileExtension,hasAugmentedPermissions,"
+            "headRevisionId,iconLink,id,"
             "imageMediaMetadata,indexableText,isAppAuthorized,kind,"
             "labels,lastModifyingUser,lastModifyingUserName,"
             "lastViewedByMeDate,markedViewedByMeDate,md5Checksum,"
             "mimeType,modifiedByMeDate,modifiedDate,openWithLinks,"
             "originalFilename,ownedByMe,ownerNames,owners,parents,"
             "permissions,properties,quotaBytesUsed,selfLink,shareable,"
-            "shared,sharedWithMeDate,sharingUser,spaces,thumbnail,"
-            "thumbnailLink,title,userPermission,version,"
-            "videoMediaMetadata,webContentLink,webViewLink,writersCanShare"
+            "shared,sharedWithMeDate,sharingUser,spaces,teamDriveId,"
+            "thumbnail,thumbnailLink,title,trashedDate,trashingUser"
+            "userPermission,version,videoMediaMetadata,webContentLink,"
+            "webViewLink,writersCanShare"
         )
         self.has_bom = True
 
@@ -537,25 +539,31 @@ def Delete(self, param=None):
     """
         self._FilesDelete(param=param)
 
-    def InsertPermission(self, new_permission):
+    def InsertPermission(self, new_permission, param=None):
         """Insert a new permission. Re-fetches all permissions after call.
 
     :param new_permission: The new permission to insert, please see the
                            official Google Drive API guide on permissions.insert
                            for details.
-
     :type new_permission: object
 
+    :param param: addition parameters to pass
+    :type param: dict
+
     :return: The permission object.
     :rtype: object
     """
-        file_id = self.metadata.get("id") or self["id"]
+        if param is None:
+            param = {}
+        param["fileId"] = self.metadata.get("id") or self["id"]
+        param["body"] = new_permission
+        # Teamdrive support
+        param["supportsAllDrives"] = True
+
         try:
             permission = (
                 self.auth.service.permissions()
-                .insert(
-                    fileId=file_id, body=new_permission, supportsAllDrives=True
-                )
+                .insert(**param)
                 .execute(http=self.http)
             )
         except errors.HttpError as error:

tox.ini

@@ -1,12 +1,14 @@
 [tox]
-envlist = py26, py27, py33, py34
+envlist = py36, py37, py38, py39
 
 [testenv]
 changedir = {toxinidir}/pydrive2/test
 deps =
     pytest
     httplib2
     PyYAML
+    timeout_decorator
+    futures
     git+https://github.com/google/google-api-python-client.git
 commands =
     py.test -v -s