Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyangle/google_drive
Google drive v3 crystal lang client generated by OpenAPI Generator
https://github.com/cyangle/google_drive
crystal crystal-lang google-drive google-drive-api openapi-generator
Last synced: 3 months ago
JSON representation
Google drive v3 crystal lang client generated by OpenAPI Generator
- Host: GitHub
- URL: https://github.com/cyangle/google_drive
- Owner: cyangle
- License: mit
- Created: 2021-11-21T00:30:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T20:29:47.000Z (5 months ago)
- Last Synced: 2024-09-07T21:36:27.568Z (5 months ago)
- Topics: crystal, crystal-lang, google-drive, google-drive-api, openapi-generator
- Language: Crystal
- Homepage:
- Size: 556 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# google_drive
The Crystal module for the Drive API
Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project with CUSTOM templates:
- API version: v3
- Package version: 3.4.1
- Build package: org.openapitools.codegen.languages.CrystalClientCodegen
- Custom templates: [crystal_client_generator](https://github.com/cyangle/crystal_client_generator)
For more information, please visit [https://google.com](https://google.com)
## Installation
### Install from Git
Add the following to shard.yaml
```yaml
dependencies:
google_drive:
github: cyangle/google_drive
version: ~> 3.4.1
```
## Usage
Check [here](https://developers.google.com/drive/api/v3/reference) for more information about how to use google drive v3 APIs.
Below lists only a few examples of the most interesting APIs, the client should support all APIs provided by google drive as it's generated from the OpenAPI v3 specification `./google-drive-api-v3-oas3.json`.
### Require this shard in your project
First you need to require it.
```crystal
require "google_drive"
```
Or require a specific api only.
```crystal
require "google_drive/api/files_api"
```
### Configure client with google OAuth2 access token
```crystal
GoogleDrive.configure do |config|
config.access_token = "Google OAuth2 Access Token"
end
```
### FilesApi
```crystal
files_api = GoogleDrive::FilesApi.new
```
#### List files
```crystal
files_api.list(page_size: 10, spaces: "appDataFolder")
```
#### Get file meta data by id
```crystal
file_meta : GoogleDrive::File = files_api.get(file_id: "unique_file_id")
```
#### Download file by id
```crystal
files_api.get(file_id: "unique_file_id", alt: "media") do |response|
File.open("my_file.txt", "w") do |file|
IO.copy(response.body_io, file)
end
end
```
#### Upload file
##### Simple upload
```crystal
new_file_meta : GoogleDrive::File = files_api.upload(
upload_type: "media",
media: File.open("./test.json")
)
```
##### Multipart upload
```crystal
file_meta = GoogleDrive::File.new(
name: "test.json",
mime_type: "application/json",
parents: ["appDataFolder"]
)
new_file_meta : GoogleDrive::File = files_api.upload(
upload_type: "multipart",
metadata: IO::Memory.new(file_meta.to_json),
media: File.open("./test.json")
)
```
#### Create folder
```crystal
folder = GoogleDrive::File.new(
name: "my_app",
mime_type: "application/vnd.google-apps.folder",
parents: ["appDataFolder"]
)
files_api.create(file: folder)
```
#### Update file metadata by id
Update file name.
```crystal
file_meta = GoogleDrive::File.new(name: "new_name.json")
files_api.update(file_id: "unique_file_id", file: file_meta)
```
#### Update file content by id
```crystal
files_api.update_content(file_id: "unique_file_id", media: File.open("./test2.json"))
```
#### Delete file by id
```crystal
files_api.delete(file_id: "unique_file_id")
```
## Development
Install dependencies
```shell
shards
```
Run the tests:
```shell
crystal spec
```
Run lints
```shell
./bin/ameba
crystal tool format --check
```