X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/589d3e8ccbc54bcaf6a62d4ab9a900875eb01100..31a78788bd0db6957bc754a078c880d6f6b5f23d:/README.md
diff --git a/README.md b/README.md
index 85e796cab6..840b0476b6 100644
--- a/README.md
+++ b/README.md
@@ -1,61 +1,21 @@
-# APIClient
+# Google API Client
- Homepage
- http://code.google.com/p/google-api-ruby-client
- - Author
- Bob Aman
+ - Authoris
- Bob Aman, Steven Bazyl
- Copyright
- Copyright © 2011 Google, Inc.
- License
- Apache 2.0
-# Description
+[](http://travis-ci.org/google/google-api-ruby-client)
+[](https://gemnasium.com/google/google-api-ruby-client)
+
+## Description
The Google API Ruby Client makes it trivial to discover and access supported
APIs.
-# Example Usage
-
- # Initialize the client
- require 'google/api_client'
- require 'signet/oauth_1/client'
- client = Google::APIClient.new(
- :service => 'buzz',
- # Buzz has API-specific endpoints
- :authorization => Signet::OAuth1::Client.new(
- :temporary_credential_uri =>
- 'https://www.google.com/accounts/OAuthGetRequestToken',
- :authorization_uri =>
- 'https://www.google.com/buzz/api/auth/OAuthAuthorizeToken',
- :token_credential_uri =>
- 'https://www.google.com/accounts/OAuthGetAccessToken',
- :client_credential_key => 'anonymous',
- :client_credential_secret => 'anonymous'
- )
- )
- client.authorization.fetch_temporary_credential!(
- :additional_parameters => {
- 'scope' => 'https://www.googleapis.com/auth/buzz'
- }
- )
- redirect_uri = client.authorization.authorization_uri(
- :additional_parameters => {
- 'domain' => client.authorization.client_credential_key,
- 'scope' => 'https://www.googleapis.com/auth/buzz'
- }
- )
- # Redirect user here
- client.authorization.fetch_token_credential!(:verifier => '12345')
-
- # Discover available methods
- method_names = client.discovered_api('buzz').to_h.keys
-
- # Make an API call
- response = client.execute(
- 'chili.activities.list',
- {'scope' => '@self', 'userId' => '@me', 'alt' => 'json'}
- )
- status, headers, body = response
-
-# Install
+## Install
Be sure `http://rubygems.org/` is in your gem sources.
@@ -67,3 +27,152 @@ The command line interface, the example applications, and the test suite
require additional dependencies. These may be obtained with:
$ sudo gem install google-api-client --development --force --no-rdoc --no-ri
+
+## Example Usage
+
+ # Initialize the client & Google+ API
+ require 'google/api_client'
+ client = Google::APIClient.new
+ plus = client.discovered_api('plus')
+
+ # Initialize OAuth 2.0 client
+ client.authorization.client_id = ''
+ client.authorization.client_secret = ''
+ client.authorization.redirect_uri = ''
+
+ client.authorization.scope = 'https://www.googleapis.com/auth/plus.me'
+
+ # Request authorization
+ redirect_uri = client.authorization.authorization_uri
+
+ # Wait for authorization code then exchange for token
+ client.authorization.code = '....'
+ client.authorization.fetch_access_token!
+
+ # Make an API call
+ result = client.execute(
+ :api_method => plus.activities.list,
+ :parameters => {'collection' => 'public', 'userId' => 'me'}
+ )
+
+ puts result.data
+
+## API Features
+
+### API Discovery
+
+To take full advantage of the client, load API definitions prior to use. To load an API:
+
+ urlshortener = client.discovered_api('urlshortener')
+
+Specific versions of the API can be loaded as well:
+
+ drive = client.discovered_api('drive', 'v2')
+
+Locally cached discovery documents may be used as well. To load an API from a local file:
+
+ doc = File.read('my-api.json')
+ my_api = client.register_discovery_document('myapi', 'v1', doc)
+
+### Authorization
+
+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).
+
+Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
+
+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`.
+
+ client = Google::APIClient.new
+ key = Google::APIClient::PKCS12.load_key('client.p12', 'notasecret')
+ service_account = Google::APIClient::JWTAsserter.new(
+ '123456-abcdef@developer.gserviceaccount.com',
+ 'https://www.googleapis.com/auth/prediction',
+ key)
+ client.authorization = service_account.authorize
+
+### Batching Requests
+
+Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
+to bundle multiple requests together.
+
+Example:
+
+ client = Google::APIClient.new
+ urlshortener = client.discovered_api('urlshortner')
+
+ batch = Google::APIClient::BatchRequest.new do |result|
+ puts result.data
+ end
+
+ batch.add(:api_method => urlshortener.url.insert,
+ :body_object => { 'longUrl' => 'http://example.com/foo' })
+ batch.add(:api_method => urlshortener.url.insert,
+ :body_object => { 'longUrl' => 'http://example.com/bar' })
+ client.execute(batch)
+
+Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
+
+ batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
+ puts result.data
+ end
+
+### Media Upload
+
+For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
+uploads can be used. For example, to upload a file to Google Drive using multipart
+
+ drive = client.discovered_api('drive', 'v2')
+
+ media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
+ metadata = {
+ 'title' => 'My movie',
+ 'description' => 'The best home movie ever made'
+ }
+ client.execute(:api_method => drive.files.insert,
+ :parameters => { 'uploadType' => 'multipart' },
+ :body_object => metadata,
+ :media => media )
+
+To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
+and continue if necessary, check `result.resumable_upload`.
+
+ client.execute(:api_method => drive.files.insert,
+ :parameters => { 'uploadType' => 'resumable' },
+ :body_object => metadata,
+ :media => media )
+ upload = result.resumable_upload
+
+ # Resume if needed
+ if upload.resumable?
+ client.execute(upload)
+ end
+
+## Command Line
+
+Included with the gem is a command line interface for working with Google APIs.
+
+ # Log in
+ google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
+
+ # List the signed-in user's activities
+ google-api execute plus.activities.list --api=plus -- userId="me" collection="public"
+
+ # Start an interactive API session
+ google-api irb
+ >> plus = $client.discovered_api('plus')
+ >> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
+ => # returns a response from the API
+
+For more information, use `google-api --help`
+
+## Samples
+
+See the full list of [samples on Google Code](http://code.google.com/p/google-api-ruby-client/source/browse?repo=samples).
+
+
+## Support
+
+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).
+
+
+