Go to file
Tim Emiola 83cd8d5581 Merge pull request #6 from tbetbetbe/ruby-auth-add-top-level-docs
Adds top-level documentation and testing metadata
2015-02-24 18:29:00 -08:00
lib Updates the comment to link to Application Default Credentials 2015-02-24 15:01:11 -08:00
spec Adds an implementation of Application Default Credentials 2015-02-12 16:59:08 -08: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
.travis.yml Adds top-level documentation and testing metadata 2015-02-24 18:20:43 -08:00
CONTRIBUTING.md Adds top-level documentation and testing metadata 2015-02-24 18:20:43 -08: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 top-level documentation and testing metadata 2015-02-24 18:20:43 -08:00
Rakefile Extract the auth library into its own project 2015-02-11 19:23:34 -08:00
googleauth.gemspec Fixes the doc url 2015-02-12 05:00:19 -08: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

Build Status Dependency Status

Description

This 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 google-auth-library

Example Usage

require 'googleauth'

# Get the environment configured authorization
scope = 'https://www.googleapis.com/auth/userinfo.profile'
authorization = Google::Auth.get_application_default(scope)

# 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.