google-api-ruby-client/README.md

202 lines
7.0 KiB
Markdown
Raw Normal View History

2012-10-04 22:48:49 +00:00
# Google API Client
<dl>
2013-04-08 23:07:58 +00:00
<dt>Homepage</dt><dd><a href="http://www.github.com/google/google-api-ruby-client">http://www.github.com/google/google-api-ruby-client</a></dd>
2013-01-18 17:21:13 +00:00
<dt>Authors</dt><dd>Bob Aman, <a href="mailto:sbazyl@google.com">Steven Bazyl</a></dd>
<dt>Copyright</dt><dd>Copyright © 2011 Google, Inc.</dd>
<dt>License</dt><dd>Apache 2.0</dd>
</dl>
2012-05-11 10:16:38 +00:00
[![Build Status](https://secure.travis-ci.org/google/google-api-ruby-client.png)](http://travis-ci.org/google/google-api-ruby-client)
[![Dependency Status](https://gemnasium.com/google/google-api-ruby-client.png)](https://gemnasium.com/google/google-api-ruby-client)
2012-10-04 22:48:49 +00:00
## Description
The Google API Ruby Client makes it trivial to discover and access supported
APIs.
2014-10-03 20:37:40 +00:00
## Alpha
2014-10-03 20:43:40 +00:00
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.
2014-10-03 20:37:40 +00:00
2012-10-04 22:48:49 +00:00
## Install
Be sure `https://rubygems.org/` is in your gem sources.
2012-10-04 22:48:49 +00:00
For normal client usage, this is sufficient:
2013-04-29 02:29:39 +00:00
```bash
$ gem install google-api-client
```
2012-10-04 22:48:49 +00:00
## Example Usage
2013-04-29 02:29:39 +00:00
```ruby
require 'google/api_client'
require 'google/api_client/client_secrets'
2013-08-09 13:43:40 +00:00
require 'google/api_client/auth/installed_app'
2012-09-24 22:21:56 +00:00
# Initialize the client.
client = Google::APIClient.new(
:application_name => 'Example Ruby application',
:application_version => '1.0.0'
)
2013-06-16 12:15:06 +00:00
# Initialize Google+ API. Note this will make a request to the
# discovery service every time, so be sure to use serialization
# in your production code. Check the samples for more details.
plus = client.discovered_api('plus')
2012-10-04 22:48:49 +00:00
# Load client secrets from your client_secrets.json.
client_secrets = Google::APIClient::ClientSecrets.load
2012-09-24 22:21:56 +00:00
# Run installed application flow. Check the samples for a more
# complete example that saves the credentials between runs.
flow = Google::APIClient::InstalledAppFlow.new(
:client_id => client_secrets.client_id,
:client_secret => client_secrets.client_secret,
:scope => ['https://www.googleapis.com/auth/plus.me']
)
2013-08-09 13:41:53 +00:00
client.authorization = flow.authorize
2012-10-04 22:48:49 +00:00
# Make an API call.
2013-04-29 02:29:39 +00:00
result = client.execute(
:api_method => plus.activities.list,
:parameters => {'collection' => 'public', 'userId' => 'me'}
)
2013-04-29 02:29:39 +00:00
puts result.data
```
2012-10-04 22:48:49 +00:00
## API Features
### API Discovery
To take full advantage of the client, load API definitions prior to use. To load an API:
2013-04-29 02:29:39 +00:00
```ruby
urlshortener = client.discovered_api('urlshortener')
```
2012-10-04 22:48:49 +00:00
Specific versions of the API can be loaded as well:
2013-04-29 02:29:39 +00:00
```ruby
drive = client.discovered_api('drive', 'v2')
```
2012-10-04 22:48:49 +00:00
Locally cached discovery documents may be used as well. To load an API from a local file:
2013-04-29 02:29:39 +00:00
```ruby
# Output discovery document to JSON
File.open('my-api.json', 'w') do |f| f.puts MultiJson.dump(client.discovery_document('myapi', 'v1')) end
# Read discovery document and load API
2013-04-29 02:29:39 +00:00
doc = File.read('my-api.json')
client.register_discovery_document('myapi', 'v1', doc)
my_api = client.discovered_api('myapi', 'v1')
2013-04-29 02:29:39 +00:00
```
2012-10-04 22:48:49 +00:00
### Authorization
2013-06-16 12:15:06 +00:00
Most interactions with Google APIs require users to authorize applications via OAuth 2.0. The client library uses [Signet](https://github.com/google/signet) to handle most aspects of authorization. For additional details about Google's OAuth support, see [Google Developers](https://developers.google.com/accounts/docs/OAuth2).
2012-10-04 22:48:49 +00:00
Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
2013-06-16 12:15:06 +00:00
2013-01-05 00:13:03 +00:00
For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
2013-04-29 02:29:39 +00:00
```ruby
key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
client.authorization = Signet::OAuth2::Client.new(
:token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
:audience => 'https://accounts.google.com/o/oauth2/token',
:scope => 'https://www.googleapis.com/auth/prediction',
:issuer => '123456-abcdef@developer.gserviceaccount.com',
:signing_key => key)
client.authorization.fetch_access_token!
client.execute(...)
2013-06-16 12:15:06 +00:00
```
2013-09-10 22:31:24 +00:00
Service accounts are also used for delegation in Google Apps domains. The target user for impersonation is specified by setting the `:person` parameter to the user's email address
in the credentials. Detailed instructions on how to enable delegation for your domain can be found at [developers.google.com](https://developers.google.com/drive/delegation).
2014-01-22 23:40:06 +00:00
### Automatic Retries & Backoff
The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to
the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry.
The default value for retries is 0, but will be enabled by default in future releases.
2013-09-10 22:31:24 +00:00
2012-10-04 22:48:49 +00:00
### Batching Requests
2012-10-04 22:48:49 +00:00
Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
to bundle multiple requests together.
2012-10-04 22:48:49 +00:00
Example:
2013-04-29 02:29:39 +00:00
```ruby
client = Google::APIClient.new
urlshortener = client.discovered_api('urlshortner')
2013-06-16 12:15:06 +00:00
2013-04-29 02:29:39 +00:00
batch = Google::APIClient::BatchRequest.new do |result|
puts result.data
end
2013-06-16 12:15:06 +00:00
batch.add(:api_method => urlshortener.url.insert,
2013-04-29 02:29:39 +00:00
:body_object => { 'longUrl' => 'http://example.com/foo' })
2013-06-16 12:15:06 +00:00
batch.add(:api_method => urlshortener.url.insert,
2013-04-29 02:29:39 +00:00
:body_object => { 'longUrl' => 'http://example.com/bar' })
client.execute(batch)
```
2013-06-16 12:15:06 +00:00
2012-10-04 22:48:49 +00:00
Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
2013-04-29 02:29:39 +00:00
```ruby
batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
puts result.data
end
```
2012-10-04 22:48:49 +00:00
### Media Upload
For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
uploads can be used. For example, to upload a file to Google Drive using multipart
2013-04-29 02:29:39 +00:00
```ruby
drive = client.discovered_api('drive', 'v2')
2013-06-16 12:15:06 +00:00
2013-04-29 02:29:39 +00:00
media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
metadata = {
'title' => 'My movie',
'description' => 'The best home movie ever made'
}
client.execute(:api_method => drive.files.insert,
:parameters => { 'uploadType' => 'multipart' },
:body_object => metadata,
:media => media )
```
2013-06-16 12:15:06 +00:00
2012-10-04 22:48:49 +00:00
To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
and continue if necessary, check `result.resumable_upload`.
2013-04-29 02:29:39 +00:00
```ruby
client.execute(:api_method => drive.files.insert,
:parameters => { 'uploadType' => 'resumable' },
:body_object => metadata,
:media => media )
upload = result.resumable_upload
2012-10-04 22:48:49 +00:00
2013-04-29 02:29:39 +00:00
# Resume if needed
if upload.resumable?
client.execute(upload)
end
```
2012-10-25 23:21:00 +00:00
## Samples
2013-10-03 16:42:08 +00:00
See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-samples).
2012-10-25 23:21:00 +00:00
2012-10-26 00:02:59 +00:00
## Support
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).