From a55751cce93370fa8eccc168fcaa496e6775598b Mon Sep 17 00:00:00 2001 From: lecaros Date: Tue, 9 Mar 2021 18:04:28 -0500 Subject: [PATCH 1/6] prepare for publishing in maven repo --- build.gradle.kts | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index d4eea2d..e861083 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,10 +1,13 @@ plugins { - id("org.jetbrains.kotlin.jvm") version "1.4.31" + kotlin("jvm") version "1.4.31" + id("maven-publish") + id("java-library") } group = "com.merkenlabs.googleapiwrapper.drive" -version = "0.1.0-SNAPSHOT" +version = "0.1.0" +java.sourceCompatibility = JavaVersion.VERSION_1_8 repositories { mavenCentral() @@ -12,4 +15,27 @@ repositories { dependencies { implementation( "org.jetbrains.kotlin:kotlin-stdlib") + implementation("org.jetbrains.kotlin:kotlin-reflect") + + implementation("com.google.apis:google-api-services-drive:v3-rev20210207-1.31.0") +} + +tasks.withType { + kotlinOptions { + freeCompilerArgs = listOf("-Xjsr305=strict") + jvmTarget = "1.8" + } +} + + +tasks.getByName("jar") { + enabled = true +} + +publishing{ + publications { + create("google-drive-api-wrapper") { + from(components["java"]) + } + } } From 0fb6fa196737e1c366cf6bd645283e5534d42d0d Mon Sep 17 00:00:00 2001 From: lecaros Date: Tue, 9 Mar 2021 18:04:44 -0500 Subject: [PATCH 2/6] first implementation --- .../drive/AbstractDriveServiceWrapper.kt | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt diff --git a/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt b/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt new file mode 100644 index 0000000..ace01f2 --- /dev/null +++ b/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt @@ -0,0 +1,77 @@ +package com.merkenlabs.googleapiwrapper.drive + +import com.google.api.services.drive.Drive +import com.google.api.services.drive.model.File + +abstract class AbstractDriveServiceWrapper { + + /** + * Recursively copies all subfolders and files from one folder to another. + * + */ + fun copyFolderContentsIntoFolder(originFolderId: String, destinationFolderId: String) { + val foundFiles = getFilesInFolder(originFolderId) + if (foundFiles != null) { + for (file in foundFiles) { + if (file.mimeType.equals(MimeTypes.FOLDER)) { + val newFolder = createFolder(destinationFolderId, file.name) + copyFolderContentsIntoFolder(file.id, newFolder.id) + continue + } + val newFile = createNewFileWithAttributes(file, destinationFolderId) + val copyFileRequest = getDriveService().files().copy(file.id, newFile) + copyFileRequest.execute() + } + } + } + + private fun createNewFileWithAttributes( + file: File, + destinationFolderId: String + ): File { + val newFile = File() + newFile.name = file.name + newFile.parents = listOf(destinationFolderId) + return newFile + } + + private fun getFilesInFolder(originFolderId: String): List? { + val fileList = getDriveService().files().list() + .setQ("'$originFolderId' in parents") + .setFields("files(id, name, mimeType)") + .execute() + val foundFiles = fileList.files + foundFiles.sortBy { it.name } + return foundFiles + } + + fun getFolder(folderId: String): Drive.Files.Get { + return getDriveService().files().get(folderId) + } + + fun createFolder(mainFolderId: String, name: String): File { + val foundFolder = findFolderByName(name, mainFolderId) + if (!foundFolder.isNullOrEmpty()) { + return foundFolder + } + val newFolder = + File().setName(name).setMimeType(MimeTypes.FOLDER).setParents(listOf(mainFolderId)) + return getDriveService().files().create(newFolder).setFields("id, parents").execute() + } + + private fun findFolderByName(name: String, mainFolderId: String): File? { + val fileList = getDriveService().files().list() + .setQ("mimeType='${MimeTypes.FOLDER}' and name = '$name' and trashed = false and '$mainFolderId' in parents") + .execute() + if (fileList.files.isNullOrEmpty()) { + return null + } + return fileList.files.first() + } + + abstract fun getDriveService(): Drive + + object MimeTypes { + const val FOLDER = "application/vnd.google-apps.folder" + } +} \ No newline at end of file From 7df0d2ce4d0b377d7a05c734cc893b705f0c12f5 Mon Sep 17 00:00:00 2001 From: lecaros Date: Tue, 9 Mar 2021 18:05:21 -0500 Subject: [PATCH 3/6] add build folder to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 2e29e47..fe4897a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .gradle +build # Created by .ignore support plugin (hsz.mobi) ### Kotlin template # Compiled class file From 27d91703972983c1b4cd58a392cd9c5a04e0345c Mon Sep 17 00:00:00 2001 From: lecaros Date: Tue, 9 Mar 2021 18:24:22 -0500 Subject: [PATCH 4/6] first working version --- .../drive/AbstractDriveServiceWrapper.kt | 18 ++++++------------ .../drive/IDriveServiceWrapper.kt | 17 +++++++++++++++++ 2 files changed, 23 insertions(+), 12 deletions(-) create mode 100644 src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/IDriveServiceWrapper.kt diff --git a/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt b/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt index ace01f2..f4215b5 100644 --- a/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt +++ b/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/AbstractDriveServiceWrapper.kt @@ -3,13 +3,9 @@ package com.merkenlabs.googleapiwrapper.drive import com.google.api.services.drive.Drive import com.google.api.services.drive.model.File -abstract class AbstractDriveServiceWrapper { +abstract class AbstractDriveServiceWrapper : IDriveServiceWrapper { - /** - * Recursively copies all subfolders and files from one folder to another. - * - */ - fun copyFolderContentsIntoFolder(originFolderId: String, destinationFolderId: String) { + override fun copyFolderContentsIntoFolder(originFolderId: String, destinationFolderId: String) { val foundFiles = getFilesInFolder(originFolderId) if (foundFiles != null) { for (file in foundFiles) { @@ -35,7 +31,7 @@ abstract class AbstractDriveServiceWrapper { return newFile } - private fun getFilesInFolder(originFolderId: String): List? { + override fun getFilesInFolder(originFolderId: String): List? { val fileList = getDriveService().files().list() .setQ("'$originFolderId' in parents") .setFields("files(id, name, mimeType)") @@ -45,11 +41,11 @@ abstract class AbstractDriveServiceWrapper { return foundFiles } - fun getFolder(folderId: String): Drive.Files.Get { + override fun getFolder(folderId: String): Drive.Files.Get { return getDriveService().files().get(folderId) } - fun createFolder(mainFolderId: String, name: String): File { + override fun createFolder(mainFolderId: String, name: String): File { val foundFolder = findFolderByName(name, mainFolderId) if (!foundFolder.isNullOrEmpty()) { return foundFolder @@ -59,7 +55,7 @@ abstract class AbstractDriveServiceWrapper { return getDriveService().files().create(newFolder).setFields("id, parents").execute() } - private fun findFolderByName(name: String, mainFolderId: String): File? { + override fun findFolderByName(name: String, mainFolderId: String): File? { val fileList = getDriveService().files().list() .setQ("mimeType='${MimeTypes.FOLDER}' and name = '$name' and trashed = false and '$mainFolderId' in parents") .execute() @@ -69,8 +65,6 @@ abstract class AbstractDriveServiceWrapper { return fileList.files.first() } - abstract fun getDriveService(): Drive - object MimeTypes { const val FOLDER = "application/vnd.google-apps.folder" } diff --git a/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/IDriveServiceWrapper.kt b/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/IDriveServiceWrapper.kt new file mode 100644 index 0000000..f31bc04 --- /dev/null +++ b/src/main/kotlin/com/merkenlabs/googleapiwrapper/drive/IDriveServiceWrapper.kt @@ -0,0 +1,17 @@ +package com.merkenlabs.googleapiwrapper.drive + +import com.google.api.services.drive.Drive +import com.google.api.services.drive.model.File + +interface IDriveServiceWrapper { + /** + * Recursively copies all subfolders and files from one folder to another. + * + */ + fun copyFolderContentsIntoFolder(originFolderId: String, destinationFolderId: String) + fun getFilesInFolder(originFolderId: String): List? + fun getFolder(folderId: String): Drive.Files.Get + fun createFolder(mainFolderId: String, name: String): File + fun findFolderByName(name: String, mainFolderId: String): File? + fun getDriveService(): Drive +} \ No newline at end of file From 585005497a689f2fce17fd625b4b38aa751983e2 Mon Sep 17 00:00:00 2001 From: lecaros Date: Tue, 9 Mar 2021 18:24:56 -0500 Subject: [PATCH 5/6] add README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25ef8c8 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Google Drive Api Wrapper + +This is a wrapper around the Google Drive (google-api-services-drive v3). + +## Disclaimer :) +This project was started and is modified according to the needs I'm experiencing, in the hope that someone else will find it helpful. +For any request please open an issue. + +## How to use + +Extend class AbstractDriveServiceWrapper and implement required methods. For example: +```kotlin +override fun getDriveService(): Drive { + return Drive.Builder(httpTransport, jsonFactory, loadCredential()) + .setApplicationName(applicationProperties.name).build() +} + ``` + +## Current features +* Allows recursive copy of all elements from a folder to another by their ids. +* Allows creation of a folder with a name and parent folder id. +* Gets a list of files inside a folder. Only first level children. +* Find a folder by name inside a parent folder. + +## Versions +### 0.1.0 +* Allows recursive copy of all elements from a folder to another by their ids. +* Allows creation of a folder with a name and parent folder id. +* Gets a list of files inside a folder. Only first level children. +* Find a folder by name inside a parent folder. \ No newline at end of file From f306301afa8b49faade6cd269a8bb2a4ef0c4e2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Lecaros?= Date: Tue, 9 Mar 2021 18:32:49 -0500 Subject: [PATCH 6/6] Create LICENSE --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.