README.md

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