Merge pull request #182 from knorth55/add-gdrive

add gdrive_ros package

gdrive_ros/CMakeLists.txt

@@ -0,0 +1,33 @@
+cmake_minimum_required(VERSION 2.8.3)
+project(gdrive_ros)
+
+find_package(catkin REQUIRED COMPONENTS
+  std_msgs
+  message_generation
+)
+
+add_service_files(
+  FILES
+  Upload.srv
+  MultipleUpload.srv
+)
+
+generate_messages(
+  DEPENDENCIES
+  std_msgs
+)
+
+catkin_package(
+  CATKIN_DEPENDS
+  message_runtime
+)
+
+install(DIRECTORY node_scripts
+  DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION}
+  USE_SOURCE_PERMISSIONS
+)
+
+install(DIRECTORY launch
+  DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION}
+  USE_SOURCE_PERMISSIONS
+)

gdrive_ros/README.md

@@ -0,0 +1,215 @@
+# gdrive_ros
+
+Google Drive file uploader for ROS
+
+## Installation
+
+### Setup and build workspace 
+
+```bash
+cd ~
+mkdir gdrive_ws/src -p
+cd gdrive_ws/src
+git clone https://github.com/jsk-ros-pkg/jsk_3rdparty.git
+rosdep install --ignore-src -from-paths . -y -r
+cd ~/gdrive_ws
+catkin init
+catkin build
+```
+
+### Do authentication of Google Drive API
+
+Please follow step 1-5 in [here](https://gsuitedevs.github.io/PyDrive/docs/build/html/quickstart.html#authentication).
+
+### Create your settings yaml
+
+Please follow [here](https://gsuitedevs.github.io/PyDrive/docs/build/html/oauth.html#sample-settings-yaml).
+
+My settings yaml is as follows;
+
+```yaml
+client_config_file: /your/client/secrets/json/path
+save_credentials: True
+save_credentials_backend: file
+save_credentials_file: /your/credentials/json/path
+get_refresh_token: True
+oauth_scope:
+  - https://www.googleapis.com/auth/drive.file
+```
+
+If you set `save_credentials: True`, you need to login to your Google account only for the first time.
+
+### Run server for the first time and login to Google account
+
+Run google drive server and login to Google account for the first time.
+
+```bash
+export GOOGLE_DRIVE_SETTINGS_YAML=/your/settings/yaml/path
+roslaunch gdrive_ros gdrive_server.launch
+```
+
+
+## Usage
+
+### Run server
+```bash
+export GOOGLE_DRIVE_SETTINGS_YAML=/your/settings/yaml/path
+roslaunch gdrive_ros gdrive_server.launch
+```
+
+### Call upload service
+
+```bash
+# single upload
+rosservice call /gdrive_ros/upload ...
+# multiple upload
+rosservice call /gdrive_ros/upload_multi ...
+```
+
+## Parameters
+
+- `~settings_yaml` (`string`, default: `None`)
+
+  - PyDrive settings yaml path
+
+- `~share_type` (`string`, default: `anyone`, candidates: `user`, `group`, `domain` and `anyone`)
+
+  - Uploaded file share type
+
+  - For more information, please read [here](https://developers.google.com/drive/api/v3/reference/permissions#type).
+
+- `~share_value` (`string`, default: `anyone`)
+
+  - Uploaded file share value
+
+- `~share_role` (`string`, default: `reader`)
+
+  - Uploaded file share role
+
+- `~share_with_link` (`bool`, default: `true`)
+
+  - Uploaded file share with link or not 
+
+## Services
+
+### `gdrive_ros/Upload`
+
+This service is for uploading single file in same Google Drive folder.
+
+**Request**
+
+- `file_path` (`string`, default: `''`)
+
+  - Uploaded file path
+
+- `file_title` (`string`: default: `file_path.split('/')[-1]`)
+
+  - Uploaded file title in Google Drive
+
+
+- `parents_path` (`string`, default: `''`)
+
+  - Parents path in Google Drive splitted by `/`
+
+
+- `parents_id` (`string`, default: `''`)
+
+  - Parents id in Google Drive
+
+  - If both `parents_path` and `parents_id` are set , `parents_id` will be used.
+
+- `use_timestamp_folder` (`bool`, default: `false`)
+
+  - Use timestamp folder to upload
+
+  - Uploaded file will be saved in `file_path/timestamp` folder.
+
+- `use_timestamp_file_title` (`bool`, default: `false`)
+
+  - Use timestamp for `file_title`
+
+  - Uploaded file will be save as `{}_{}.format(timestamp file_title)`. 
+
+
+**Response**
+
+- `success` (`bool`)
+
+  - Upload succeeded or not
+
+- `file_id` (`string`)
+
+  - Uploaded file id in Google Drive
+
+- `file_url` (`string`)
+
+  - Uploaded file url in Google Drive
+
+- `parents_id` (`string`)
+
+  - Parents folder id of uploaded file in Google Drive
+
+- `parents_url` (`string`)
+
+  - Parents folder url of uploaded file in Google Drive
+
+### `gdrive_ros/MultipleUpload`
+
+This service is for uploading multiple files in same Google Drive folder.
+
+**Request**
+
+- `file_paths` (`string[]`, default: `[]`)
+
+  - Uploaded file paths
+
+- `file_titles` (`string[]`: default: `[f for f in file_paths.split('/')[-1]]`)
+
+  - Uploaded file titles in Google Drive
+
+
+- `parents_path` (`string`, default: `''`)
+
+  - Parents path in Google Drive splitted by `/`
+
+
+- `parents_id` (`string`, default: `''`)
+
+  - Parents id in Google Drive
+
+  - If both `parents_path` and `parents_id` are set , `parents_id` will be used.
+
+- `use_timestamp_folder` (`bool`, default: `false`)
+
+  - Use timestamp folder to upload
+
+  - Uploaded file will be saved in `file_path/timestamp` folder.
+
+- `use_timestamp_file_title` (`bool`, default: `false`)
+
+  - Use timestamp for `file_title`
+
+  - Uploaded file will be save as `{}_{}.format(timestamp file_title)`. 
+
+
+**Response**
+
+- `successes` (`bool[]`)
+
+  - Upload succeeded or not
+
+- `file_ids` (`string[]`)
+
+  - Uploaded file ids in Google Drive
+
+- `file_urls` (`string[]`)
+
+  - Uploaded file urls in Google Drive
+
+- `parents_id` (`string`)
+
+  - Parents folder id of uploaded file in Google Drive
+
+- `parents_url` (`string`)
+
+  - Parents folder url of uploaded file in Google Drive

gdrive_ros/launch/gdrive_server.launch

@@ -0,0 +1,8 @@
+<launch>
+  <arg name="settings_yaml" default="$(env GOOGLE_DRIVE_SETTINGS_YAML)" />
+  <node name="gdrive_server" pkg="gdrive_ros" type="gdrive_server_node.py" output="screen">
+    <rosparam subst_value="true">
+      settings_yaml: $(arg settings_yaml)
+    </rosparam>
+  </node>
+</launch>