README.md

   1 # Google API Client
   2
   3 <dl>
   4   <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>
   5   <dt>Authors</dt><dd>Bob Aman, <a href="mailto:sbazyl@google.com">Steven Bazyl</a></dd>
   6   <dt>Copyright</dt><dd>Copyright © 2011 Google, Inc.</dd>
   7   <dt>License</dt><dd>Apache 2.0</dd>
   8 </dl>
   9
  10 [![Build Status](https://secure.travis-ci.org/google/google-api-ruby-client.png)](http://travis-ci.org/google/google-api-ruby-client)
  11 [![Dependency Status](https://gemnasium.com/google/google-api-ruby-client.png)](https://gemnasium.com/google/google-api-ruby-client)
  12
  13 ## Description
  14
  15 The Google API Ruby Client makes it trivial to discover and access supported
  16 APIs.
  17
  18 ## Install
  19
  20 Be sure `https://rubygems.org/` is in your gem sources.
  21
  22 For normal client usage, this is sufficient:
  23
  24 ```bash
  25 $ gem install google-api-client
  26 ```
  27
  28 ## Example Usage
  29
  30 ```ruby
  31 require 'google/api_client'
  32 require 'google/api_client/client_secrets'
  33 require 'google/api_client/auth/installed_app'
  34
  35 # Initialize the client.
  36 client = Google::APIClient.new(
  37   :application_name => 'Example Ruby application',
  38   :application_version => '1.0.0'
  39 )
  40
  41 # Initialize Google+ API. Note this will make a request to the
  42 # discovery service every time, so be sure to use serialization
  43 # in your production code. Check the samples for more details.
  44 plus = client.discovered_api('plus')
  45
  46 # Load client secrets from your client_secrets.json.
  47 client_secrets = Google::APIClient::ClientSecrets.load
  48
  49 # Run installed application flow. Check the samples for a more
  50 # complete example that saves the credentials between runs.
  51 flow = Google::APIClient::InstalledAppFlow.new(
  52   :client_id => client_secrets.client_id,
  53   :client_secret => client_secrets.client_secret,
  54   :scope => ['https://www.googleapis.com/auth/plus.me']
  55 )
  56 client.authorization = flow.authorize
  57
  58 # Make an API call.
  59 result = client.execute(
  60   :api_method => plus.activities.list,
  61   :parameters => {'collection' => 'public', 'userId' => 'me'}
  62 )
  63
  64 puts result.data
  65 ```
  66
  67 ## API Features
  68
  69 ### API Discovery
  70
  71 To take full advantage of the client, load API definitions prior to use. To load an API:
  72
  73 ```ruby
  74 urlshortener = client.discovered_api('urlshortener')
  75 ```
  76
  77 Specific versions of the API can be loaded as well:
  78
  79 ```ruby
  80 drive = client.discovered_api('drive', 'v2')
  81 ```
  82
  83 Locally cached discovery documents may be used as well. To load an API from a local file:
  84
  85 ```ruby
  86 doc = File.read('my-api.json')
  87 my_api = client.register_discovery_document('myapi', 'v1', doc)
  88 ```
  89
  90 ### Authorization
  91
  92 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).
  93
  94 Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
  95
  96 For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
  97
  98 ```ruby
  99 key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
 100 client.authorization = Signet::OAuth2::Client.new(
 101   :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
 102   :audience => 'https://accounts.google.com/o/oauth2/token',
 103   :scope => 'https://www.googleapis.com/auth/prediction',
 104   :issuer => '123456-abcdef@developer.gserviceaccount.com',
 105   :signing_key => key)
 106 client.authorization.fetch_access_token!
 107 client.execute(...)
 108 ```
 109
 110 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
 111 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).
 112
 113 ### Automatic Retries & Backoff
 114
 115 The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to
 116 the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry.
 117
 118 The default value for retries is 0, but will be enabled by default in future releases.
 119
 120 ### Batching Requests
 121
 122 Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
 123 to bundle multiple requests together.
 124
 125 Example:
 126
 127 ```ruby
 128 client = Google::APIClient.new
 129 urlshortener = client.discovered_api('urlshortner')
 130
 131 batch = Google::APIClient::BatchRequest.new do |result|
 132     puts result.data
 133 end
 134
 135 batch.add(:api_method => urlshortener.url.insert,
 136           :body_object => { 'longUrl' => 'http://example.com/foo' })
 137 batch.add(:api_method => urlshortener.url.insert,
 138           :body_object => { 'longUrl' => 'http://example.com/bar' })
 139 client.execute(batch)
 140 ```
 141
 142 Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
 143
 144 ```ruby
 145 batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
 146    puts result.data
 147 end
 148 ```
 149
 150 ### Media Upload
 151
 152 For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
 153 uploads can be used. For example, to upload a file to Google Drive using multipart
 154
 155 ```ruby
 156 drive = client.discovered_api('drive', 'v2')
 157
 158 media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
 159 metadata = {
 160     'title' => 'My movie',
 161     'description' => 'The best home movie ever made'
 162 }
 163 client.execute(:api_method => drive.files.insert,
 164                :parameters => { 'uploadType' => 'multipart' },
 165                :body_object => metadata,
 166                :media => media )
 167 ```
 168
 169 To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
 170 and continue if necessary, check `result.resumable_upload`.
 171
 172 ```ruby
 173 client.execute(:api_method => drive.files.insert,
 174            :parameters => { 'uploadType' => 'resumable' },
 175            :body_object => metadata,
 176            :media => media )
 177 upload = result.resumable_upload
 178
 179 # Resume if needed
 180 if upload.resumable?
 181     client.execute(upload)
 182 end
 183 ```
 184
 185 ## Command Line
 186
 187 Included with the gem is a command line interface for working with Google APIs.
 188
 189 ```bash
 190 # Log in
 191 google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
 192
 193 # List the signed-in user's activities
 194 google-api execute plus.activities.list --api=plus -- userId="me" collection="public"
 195
 196 # Start an interactive API session
 197 google-api irb
 198 >> plus = $client.discovered_api('plus')
 199 >> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
 200 => # returns a response from the API
 201 ```
 202
 203 For more information, use `google-api --help`
 204
 205 ## Samples
 206
 207 See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-samples).
 208
 209
 210 ## Support
 211
 212 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).