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