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