google_cloud_storage

The Crystal module for the Cloud Storage JSON API

Stores and retrieves potentially large, immutable data objects.

This SDK is automatically generated by the OpenAPI Generator project with CUSTOM templates:

• API version: v1
• Package version: 0.5.1
• Build package: org.openapitools.codegen.languages.CrystalClientCodegen
• Custom templates: crystal_client_generator

For more information, please visit https://google.com

Installation

Install from Git

Add the following to shard.yaml

dependencies:
  google_cloud_storage:
    github: cyangle/google_cloud_storage
    version: ~> 0.5.1

Usage

Check here for more information about how to use google cloud storage v1 json APIs.

Below only lists API usages that are covered by tests. Please report broken APIs by creating github issues.

The client should support all APIs provided by google cloud storage v1 json APIs as it's generated from the OpenAPI v3 specification ./google_cloud_storage_v1.yml.

Require this shard in your project

First you need to require it.

require "google_cloud_storage"

# Or Require specific apis
require "google_cloud_storage/api/buckets_api"
require "google_cloud_storage/api/objects_api"

Get OAuth2 access token

You can get google cloud OAuth2 access token with service account credentials in a json file with shard google-auth.

Check here for how to create a service account.

Configure client with google OAuth2 access token

GoogleDrive.configure do |config|
  config.access_token = "Google OAuth2 Access Token"
end

BucketsApi

buckets_api = GoogleCloudStorage::BucketsApi.new

List buckets from a project

buckets : GoogleCloudStorage::Buckets = buckets_api.list(project: "google-cloud-project-id")

Get bucket metadata

bucket : GoogleCloudStorage::Bucket = buckets_api.get(bucket: "my_bucket")
pp bucket

Create a new bucket

bucket = GoogleCloudStorage::Bucket.new(name: "unique_bucket_name")
result_bucket : GoogleCloudStorage::Bucket = buckets_api.insert(project: "google-cloud-project-id", bucket: bucket)
pp result_bucket

Delete empty bucket from a project

buckets_api.delete(bucket: "empty-bucket-name")

ObjectsApi

objects_api = GoogleCloudStorage::ObjectsApi.new

List objects from bucket

objects : GoogleCloudStorage::Objects = objects_api.list(bucket: "my_bucket", prefix: "crystal", delimiter: "/")

Get object metadata

object : GoogleCloudStorage::Object = objects_api.get(bucket: "my_bucket", object: "test.json")

Download object from bucket

response = objects_api.build_api_request_for_get(bucket: "my_bucket", object: "test.json", alt: "media").execute
File.write("./test.json", response.body)

Or stream download

objects_api.get(bucket: "my_bucket", object: "test.json", alt: "media") do |response|
  File.open("./test.json", "w") do |file|
    IO.copy(response.body_io, file)
  end
end

Upload file to bucket

Simple upload

Upload file content as String

file_content = File.read("./test.json")
object : GoogleCloudStorage::Object = objects_api.insert(bucket: "my_bucket", name: "test.json", upload_type: "media", body: file_content)
pp object

Or stream upload

File.open("./test.json") do |file|
  object : GoogleCloudStorage::Object = objects_api.insert(bucket: "my_bucket", name: "test.json", upload_type: "media", body: file)
  pp object
end

Delete object from bucket

objects_api.delete(bucket: "my_bucket", object: "test.json")

Development

Install dependencies

shards

Run the tests:

crystal spec

Run lints

./bin/ameba
crystal tool format --check