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
 114 ### Batching Requests
 115
 116 Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
 117 to bundle multiple requests together.
 118
 119 Example:
 120
 121 ```ruby
 122 client = Google::APIClient.new
 123 urlshortener = client.discovered_api('urlshortner')
 124
 125 batch = Google::APIClient::BatchRequest.new do |result|
 126     puts result.data
 127 end
 128
 129 batch.add(:api_method => urlshortener.url.insert,
 130           :body_object => { 'longUrl' => 'http://example.com/foo' })
 131 batch.add(:api_method => urlshortener.url.insert,
 132           :body_object => { 'longUrl' => 'http://example.com/bar' })
 133 client.execute(batch)
 134 ```
 135
 136 Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
 137
 138 ```ruby
 139 batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
 140    puts result.data
 141 end
 142 ```
 143
 144 ### Media Upload
 145
 146 For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
 147 uploads can be used. For example, to upload a file to Google Drive using multipart
 148
 149 ```ruby
 150 drive = client.discovered_api('drive', 'v2')
 151
 152 media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
 153 metadata = {
 154     'title' => 'My movie',
 155     'description' => 'The best home movie ever made'
 156 }
 157 client.execute(:api_method => drive.files.insert,
 158                :parameters => { 'uploadType' => 'multipart' },
 159                :body_object => metadata,
 160                :media => media )
 161 ```
 162
 163 To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
 164 and continue if necessary, check `result.resumable_upload`.
 165
 166 ```ruby
 167 client.execute(:api_method => drive.files.insert,
 168            :parameters => { 'uploadType' => 'resumable' },
 169            :body_object => metadata,
 170            :media => media )
 171 upload = result.resumable_upload
 172
 173 # Resume if needed
 174 if upload.resumable?
 175     client.execute(upload)
 176 end
 177 ```
 178
 179 ## Command Line
 180
 181 Included with the gem is a command line interface for working with Google APIs.
 182
 183 ```bash
 184 # Log in
 185 google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
 186
 187 # List the signed-in user's activities
 188 google-api execute plus.activities.list --api=plus -- userId="me" collection="public"
 189
 190 # Start an interactive API session
 191 google-api irb
 192 >> plus = $client.discovered_api('plus')
 193 >> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
 194 => # returns a response from the API
 195 ```
 196
 197 For more information, use `google-api --help`
 198
 199 ## Samples
 200
 201 See the full list of [samples on Google Code](http://code.google.com/p/google-api-ruby-client/source/browse?repo=samples).
 202
 203
 204 ## Support
 205
 206 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).