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 `http://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 # Initialize the client & Google+ API
  32 require 'google/api_client'
  33 client = Google::APIClient.new
  34 plus = client.discovered_api('plus')
  35
  36 # Initialize OAuth 2.0 client
  37 client.authorization.client_id = '<CLIENT_ID_FROM_API_CONSOLE>'
  38 client.authorization.client_secret = '<CLIENT_SECRET>'
  39 client.authorization.redirect_uri = '<YOUR_REDIRECT_URI>'
  40
  41 client.authorization.scope = 'https://www.googleapis.com/auth/plus.me'
  42
  43 # Request authorization
  44 redirect_uri = client.authorization.authorization_uri
  45
  46 # Wait for authorization code then exchange for token
  47 client.authorization.code = '....'
  48 client.authorization.fetch_access_token!
  49
  50 # Make an API call
  51 result = client.execute(
  52   :api_method => plus.activities.list,
  53   :parameters => {'collection' => 'public', 'userId' => 'me'}
  54 )
  55
  56 puts result.data
  57 ```
  58
  59 ## API Features
  60
  61 ### API Discovery
  62
  63 To take full advantage of the client, load API definitions prior to use. To load an API:
  64
  65 ```ruby
  66 urlshortener = client.discovered_api('urlshortener')
  67 ```
  68
  69 Specific versions of the API can be loaded as well:
  70
  71 ```ruby
  72 drive = client.discovered_api('drive', 'v2')
  73 ```
  74
  75 Locally cached discovery documents may be used as well. To load an API from a local file:
  76
  77 ```ruby
  78 doc = File.read('my-api.json')
  79 my_api = client.register_discovery_document('myapi', 'v1', doc)
  80 ```
  81
  82 ### Authorization
  83
  84 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).
  85
  86 Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
  87
  88 For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
  89
  90 ```ruby
  91 key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
  92 client.authorization = Signet::OAuth2::Client.new(
  93   :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
  94   :audience => 'https://accounts.google.com/o/oauth2/token',
  95   :scope => 'https://www.googleapis.com/auth/prediction',
  96   :issuer => '123456-abcdef@developer.gserviceaccount.com',
  97   :signing_key => key)
  98 client.authorization.fetch_access_token!
  99 client.execute(...)
 100 ```
 101
 102 ### Batching Requests
 103
 104 Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
 105 to bundle multiple requests together.
 106
 107 Example:
 108
 109 ```ruby
 110 client = Google::APIClient.new
 111 urlshortener = client.discovered_api('urlshortner')
 112
 113 batch = Google::APIClient::BatchRequest.new do |result|
 114     puts result.data
 115 end
 116
 117 batch.add(:api_method => urlshortener.url.insert,
 118           :body_object => { 'longUrl' => 'http://example.com/foo' })
 119 batch.add(:api_method => urlshortener.url.insert,
 120           :body_object => { 'longUrl' => 'http://example.com/bar' })
 121 client.execute(batch)
 122 ```
 123
 124 Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
 125
 126 ```ruby
 127 batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
 128    puts result.data
 129 end
 130 ```
 131
 132 ### Media Upload
 133
 134 For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
 135 uploads can be used. For example, to upload a file to Google Drive using multipart
 136
 137 ```ruby
 138 drive = client.discovered_api('drive', 'v2')
 139
 140 media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
 141 metadata = {
 142     'title' => 'My movie',
 143     'description' => 'The best home movie ever made'
 144 }
 145 client.execute(:api_method => drive.files.insert,
 146                :parameters => { 'uploadType' => 'multipart' },
 147                :body_object => metadata,
 148                :media => media )
 149 ```
 150
 151 To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
 152 and continue if necessary, check `result.resumable_upload`.
 153
 154 ```ruby
 155 client.execute(:api_method => drive.files.insert,
 156            :parameters => { 'uploadType' => 'resumable' },
 157            :body_object => metadata,
 158            :media => media )
 159 upload = result.resumable_upload
 160
 161 # Resume if needed
 162 if upload.resumable?
 163     client.execute(upload)
 164 end
 165 ```
 166
 167 ## Command Line
 168
 169 Included with the gem is a command line interface for working with Google APIs.
 170
 171 ```bash
 172 # Log in
 173 google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
 174
 175 # List the signed-in user's activities
 176 google-api execute plus.activities.list --api=plus -- userId="me" collection="public"
 177
 178 # Start an interactive API session
 179 google-api irb
 180 >> plus = $client.discovered_api('plus')
 181 >> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
 182 => # returns a response from the API
 183 ```
 184
 185 For more information, use `google-api --help`
 186
 187 ## Samples
 188
 189 See the full list of [samples on Google Code](http://code.google.com/p/google-api-ruby-client/source/browse?repo=samples).
 190
 191
 192 ## Support
 193
 194 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).