# Google API Client
<dl>
- <dt>Homepage</dt><dd><a href="http://code.google.com/p/google-api-ruby-client">http://code.google.com/p/google-api-ruby-client</a></dd>
- <dt>Author
is</dt><dd>Bob Aman, <a href="mailto:sbazyl@google.com">Steven Bazyl</a></dd>
+ <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>
+ <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>
## Install
-Be sure `http://rubygems.org/` is in your gem sources.
+Be sure `https://rubygems.org/` is in your gem sources.
For normal client usage, this is sufficient:
- $ sudo gem install google-api-client
-
-The command line interface, the example applications, and the test suite
-require additional dependencies. These may be obtained with:
-
- $ sudo gem install google-api-client --development --force --no-rdoc --no-ri
+```bash
+$ gem install google-api-client
+```
## Example Usage
- # Initialize the client & Google+ API
- require 'google/api_client'
- client = Google::APIClient.new
- plus = client.discovered_api('plus')
-
- # Initialize OAuth 2.0 client
- client.authorization.client_id = '<CLIENT_ID_FROM_API_CONSOLE>'
- client.authorization.client_secret = '<CLIENT_SECRET>'
- client.authorization.redirect_uri = '<YOUR_REDIRECT_URI>'
-
- client.authorization.scope = 'https://www.googleapis.com/auth/plus.me'
-
- # Request authorization
- redirect_uri = client.authorization.authorization_uri
-
- # Wait for authorization code then exchange for token
- client.authorization.code = '....'
- client.authorization.fetch_access_token!
-
- # Make an API call
- result = client.execute(
- :api_method => plus.activities.list,
- :parameters => {'collection' => 'public', 'userId' => 'me'}
- )
-
- puts result.data
+```ruby
+require 'google/api_client'
+require 'google/api_client/client_secrets'
+require 'google/api_client/auth/installed_app'
+
+# Initialize the client.
+client = Google::APIClient.new(
+ :application_name => 'Example Ruby application',
+ :application_version => '1.0.0'
+)
+
+# 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')
+
+# Load client secrets from your client_secrets.json.
+client_secrets = Google::APIClient::ClientSecrets.load
+
+# 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']
+)
+client.authorization = flow.authorize
+
+# Make an API call.
+result = client.execute(
+ :api_method => plus.activities.list,
+ :parameters => {'collection' => 'public', 'userId' => 'me'}
+)
+
+puts result.data
+```
## API Features
To take full advantage of the client, load API definitions prior to use. To load an API:
- urlshortener = client.discovered_api('urlshortener')
+```ruby
+urlshortener = client.discovered_api('urlshortener')
+```
Specific versions of the API can be loaded as well:
- drive = client.discovered_api('drive', 'v2')
+```ruby
+drive = client.discovered_api('drive', 'v2')
+```
Locally cached discovery documents may be used as well. To load an API from a local file:
- doc = File.read('my-api.json')
- my_api = client.register_discovery_document('myapi', 'v1', doc)
+```ruby
+doc = File.read('my-api.json')
+my_api = client.register_discovery_document('myapi', 'v1', doc)
+```
### Authorization
-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).
+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).
Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
-
-For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts. Assertions for service accounts are made with `Google::APIClient::JWTAsserter`.
- client = Google::APIClient.new
- key = Google::APIClient::PKCS12.load_key('client.p12', 'notasecret')
- service_account = Google::APIClient::JWTAsserter.new(
- '123456-abcdef@developer.gserviceaccount.com',
- 'https://www.googleapis.com/auth/prediction',
- key)
- client.authorization = service_account.authorize
+For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
+
+```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(...)
+```
+
+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).
+
### Batching Requests
Example:
- client = Google::APIClient.new
- urlshortener = client.discovered_api('urlshortner')
-
- batch = Google::APIClient::BatchRequest.new do |result|
- puts result.data
- end
-
- batch.add(:api_method=>urlshortener.url.insert,
- :body_object => { 'longUrl' => 'http://example.com/foo' })
- batch.add(:api_method=>urlshortener.url.insert,
- :body_object => { 'longUrl' => 'http://example.com/bar' })
- client.execute(batch)
-
+```ruby
+client = Google::APIClient.new
+urlshortener = client.discovered_api('urlshortner')
+
+batch = Google::APIClient::BatchRequest.new do |result|
+ puts result.data
+end
+
+batch.add(:api_method => urlshortener.url.insert,
+ :body_object => { 'longUrl' => 'http://example.com/foo' })
+batch.add(:api_method => urlshortener.url.insert,
+ :body_object => { 'longUrl' => 'http://example.com/bar' })
+client.execute(batch)
+```
+
Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
- batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
- puts result.data
- end
+```ruby
+batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
+ puts result.data
+end
+```
### 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
- drive = client.discovered_api('drive', 'v2')
-
- 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 )
-
-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`.
+```ruby
+drive = client.discovered_api('drive', 'v2')
- client.execute(:api_method => drive.files.insert,
- :parameters => { 'uploadType' => 'resumable' },
+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 )
- upload = result.resumable_upload
+```
+
+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`.
+
+```ruby
+client.execute(:api_method => drive.files.insert,
+ :parameters => { 'uploadType' => 'resumable' },
+ :body_object => metadata,
+ :media => media )
+upload = result.resumable_upload
- # Resume if needed
- if upload.resumable?
- client.execute(upload)
- end
+# Resume if needed
+if upload.resumable?
+ client.execute(upload)
+end
+```
## Command Line
Included with the gem is a command line interface for working with Google APIs.
- # Log in
- google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
+```bash
+# Log in
+google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
- # List the signed-in user's activities
- google-api execute plus.activities.list --api=plus -- userId="me" collection="public"
+# List the signed-in user's activities
+google-api execute plus.activities.list --api=plus -- userId="me" collection="public"
- # Start an interactive API session
- google-api irb
- >> plus = $client.discovered_api('plus')
- >> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
- => # returns a response from the API
+# Start an interactive API session
+google-api irb
+>> plus = $client.discovered_api('plus')
+>> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
+=> # returns a response from the API
+```
For more information, use `google-api --help`
## Samples
-See the full list of [samples on Google Code](http://code.google.com/p/google-api-ruby-client/source/browse?repo=samples).
+See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-samples).
## Support
-Please [report bugs at the project on Google Code](http://code.google.com/p/google-api-ruby-client/issues/entry). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api) about the client or APIs on [StackOverflow](http://stackoverflow.com).
-
-
-
+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).
projects / arvados.git / blobdiff