chiu
/
google-auth-library-ruby
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
75 Commits 1 Branch 0 Tags 537 KiB
Ruby 99.5%
Batchfile 0.3%
Shell 0.2%
Go to file
Todd Derr 60a079a41e Fix 'raise_error' WARNINGs. 
rspec spews a warning when using raise_error without a specific error;
add "RuntimeError" to all of these occurrences.
 		2015-06-29 16:50:55 -04:00
lib Enables reading credentials from env vars. 2015-05-21 13:38:19 -07:00
spec Fix 'raise_error' WARNINGs. 2015-06-29 16:50:55 -04:00
.gitignore Ignore emacs backup files and Gemfile.lock 2015-02-11 19:19:47 -08:00
.rspec Adds top-level documentation and testing metadata 2015-02-24 18:20:43 -08:00
.rubocop.yml Add rubocop config files 2015-02-25 04:47:12 -08:00
.rubocop_todo.yml Enables reading credentials from env vars. 2015-05-21 13:38:19 -07:00
.travis.yml Updates .travis.yml to update bundler 2015-04-23 14:02:11 -07:00
CHANGELOG.md Enables reading credentials from env vars. 2015-05-21 13:38:19 -07:00
CONTRIBUTING.md Adds a CHANGELOG.md 2015-03-23 16:13:42 -07:00
COPYING Adds top-level documentation and testing metadata 2015-02-24 18:20:43 -08:00
Gemfile Extract the auth library into its own project 2015-02-11 19:23:34 -08:00
README.md Adds a version badge 2015-03-23 16:40:55 -07:00
Rakefile Adds bundler tasks 2015-02-24 22:34:27 -08:00
googleauth.gemspec relax dependent version of multi_json 2015-06-15 14:52:18 +09:00

README.md

Google Auth Library for Ruby

Homepage
http://www.github.com/google/google-auth-library-ruby
Authors
Tim Emiola
Copyright
Copyright © 2015 Google, Inc.
License
Apache 2.0

Gem Version Build Status Coverage Status Dependency Status

Description

This is Google's officially supported ruby client library for using OAuth 2.0 authorization and authentication with Google APIs.

Alpha

This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.

Install

Be sure https://rubygems.org/ is in your gem sources.

For normal client usage, this is sufficient:

$ gem install googleauth

Example Usage

require 'googleauth'

# Get the environment configured authorization
scopes =  ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/compute']
authorization = Google::Auth.get_application_default(scopes)

# Add the the access token obtained using the authorization to a hash, e.g
# headers.
some_headers = {}
authorization.apply(some_headers)

Application Default Credentials

This library provides an implementation of application default credentials for Ruby.

The Application Default Credentials provide a simple way to get authorization credentials for use in calling Google APIs.

They are best suited for cases when the call needs to have the same identity and authorization level for the application independent of the user. This is the recommended approach to authorize calls to Cloud APIs, particularly when you're building an application that uses Google Compute Engine.

What about auth in google-apis-ruby-client?

The goal is for all auth done by google-apis-ruby-client to be performed by this library. I.e, eventually google-apis-ruby-client will just take a dependency on this library. This update is a work in progress, but should be completed by Q2 2015.

License

This library is licensed under Apache 2.0. Full license text is available in COPYING.

Contributing

See CONTRIBUTING.

Support

Please report bugs at the project on Github. Don't hesitate to ask questions about the client or APIs on StackOverflow.