#google #cloud #storage

cloud-storage

A crate for uploading files to Google cloud storage, and for generating download urls

20 releases (5 breaking)

new 0.8.0 Feb 21, 2021
0.7.0 Jan 8, 2021
0.6.2 Oct 2, 2020
0.4.2 Jun 22, 2020
0.3.4 Mar 5, 2020

#18 in Web programming

Download history 1428/week @ 2020-11-07 1326/week @ 2020-11-14 1242/week @ 2020-11-21 1396/week @ 2020-11-28 1858/week @ 2020-12-05 1617/week @ 2020-12-12 1273/week @ 2020-12-19 1090/week @ 2020-12-26 1416/week @ 2021-01-02 1307/week @ 2021-01-09 817/week @ 2021-01-16 863/week @ 2021-01-23 746/week @ 2021-01-30 858/week @ 2021-02-06 1234/week @ 2021-02-13 1268/week @ 2021-02-20

5,165 downloads per month
Used in 4 crates (2 directly)

MIT license

240KB
4K SLoC

Cloud Storage

cloud-storage-rs on crates.io stripe-rust on docs.rs

A library that can be used to push blobs to Google Cloud Storage, and then generate download links to those files.

Usage

Add the following line to your Cargo.toml

[dependencies]
cloud-storage = "0.8"

Examples

// create a new Bucket
let new_bucket = NewBucket { name: "mybucket", ..Default::default() }
let bucket = Bucket::create(new_bucket).await?;
// upload a file to our new bucket
let content = b"Your file is now on google cloud storage!";
bucket.upload(content, "folder/filename.txt", "application/text").await?;
let mut object = Object::create("mybucket", content, "folder/filename.txt", "application/text").await?;
// let's copy the file
object.copy("mybucket2: electric boogaloo", "otherfolder/filename.txt").await?;
// print a link to the file
println!("{}", object.download_url(1000)); // download link for 1000 seconds
// remove the file from the bucket
object.delete().await?;

Authorization can be granted using the SERVICE_ACCOUNT or GOOGLE_APPLICATION_CREDENTIALS environment variable, which should contain path to the service-account-*******.json file that contains the Google credentials. Alternatively, the service account credentials can be provided as JSON directly through the SERVICE_ACCOUNT_JSON or GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable, which is useful when providing secrets in CI or k8s.

The service account requires the permission devstorage.full_control. This is not strictly necessary, so if you need this fixed, let me know!
The service account should also have the roles Service Account Token Creator (for generating access tokens) and Storage Object Admin (for generating sign urls to download the files).

Sync

If you're not (yet) interested in running an async executor, then cloud_storage exposes a sync api. To use it, enable the feature flag sync, and then call instead of calling function().await, call function_sync().

Testing

To run the tests for this project, first create an enviroment parameter (or entry in the .env file) named TEST_BUCKET. Make sure that this name is not already in use! The tests will create this bucket for its testing purposes. It will also create a couple of other buckets with this name as prefix, but these will be deleted again. Next, you will need a Google Cloud Storage project, for which you must create a service account. Download the service-account.json file and place the path to the file in the SERVICE_ACCOUNT environment parameter. Then, run

cargo test --tests --features=sync -- --test-threads=1

The test-threads=1 is necessary so that the tests don't exceed the 2 per second bucket creating rate limit. (Depending on your internet speed, you may be able to use more than 1 test thread)

Dependencies

~14–19MB
~453K SLoC