Project

gcs-signer

0.0
No commit activity in last 3 years
No release in over 3 years
gcs-signershakrmedia/gcs-signerHomepageDocumentationSource CodeBug Tracker
Simple signed URL generator for Google Cloud Storage. No API requests required to generate signed URL.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
28,315
Stars
3
Forks
1
Watchers
4
 Releases
Current version
0.4.1
Total releases
6
First release
2016-12-27
Latest release
2021-02-03
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
4
Pull Request Acceptance Rate
80%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-06-09
Reverse Dependencies
0

 Dependencies

Development

pry
~> 0.11
rake
~> 12.3
rubocop
~> 1.0

Runtime

addressable
~> 2.7
 Project Readme

gcs-signer

Simple signed URL generator for Google Cloud Storage.

Features

  • No network connection required to generate signed URL.
  • Can read JSON service-account credentials from environment variables. So it can be used with google-cloud-ruby without additional configurations.

Installation

gem install gcs-signer

Usage

Authentication

If you already configured GOOGLE_APPLICATION_CREDENTIALS for google-cloud-ruby gem, just

signer = GcsSigner.new

You can also set GOOGLE_CLOUD_KEYFILE_JSON environment varialble to the content of service-account.json.

puts ENV["GOOGLE_CLOUD_KEYFILE_JSON"]
# => { "type": "service_account", ...
signer = GcsSigner.new

or you can give path of the service account file, or contents of it without using environment variables.

signer = GcsSigner.new path: "/home/leo/path/to/service_account.json"

signer = GcsSigner.new keyfile_json: '{ "type": "service_account", ...'

Signing URL

#sign_url to generate signed URL.

# The signed URL is valid for 5 minutes by default.
signer.sign_url "bucket-name", "path/to/object"

# You can specify timestamps or how many seconds the signed URL is valid for.
signer.sign_url "bucket-name", "object-name",
                expires: Time.new(2016, 12, 26, 14, 31, 48)

signer.sign_url "bucket-name", "object_name", valid_for: 600

# If you use AcriveSupport in your project, you can use some sugar like:
signer.sign_url "bucket", "object", valid_for: 45.minutes
signer.sign_url "bucket", "object", expires_at: 5.minutes.from_now

# You can set response_content_disposition and response_content_type to change response headers.
signer.sign_url "bucket", "object", response_content_type: "video/mp4"
signer.sign_url "bucket", "object", response_content_disposition: "attachment; filename=video.mp4"

# You can use V4 signing if you prefer longer URL
signer.sign_url "bucket", "object", version: :v4

License

gcs-signer is distributed under the MIT License.