Merge pull request #49 from dillonkearns/patch-1
Add syntax highlighting to README
This commit is contained in:
		
						commit
						9cd5601134
					
				
							
								
								
									
										26
									
								
								README.md
								
								
								
								
							
							
						
						
									
										26
									
								
								README.md
								
								
								
								
							| 
						 | 
					@ -21,10 +21,13 @@ Be sure `http://rubygems.org/` is in your gem sources.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
For normal client usage, this is sufficient:
 | 
					For normal client usage, this is sufficient:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
$ gem install google-api-client
 | 
					$ gem install google-api-client
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Example Usage
 | 
					## Example Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
# Initialize the client & Google+ API
 | 
					# Initialize the client & Google+ API
 | 
				
			||||||
require 'google/api_client'
 | 
					require 'google/api_client'
 | 
				
			||||||
client = Google::APIClient.new
 | 
					client = Google::APIClient.new
 | 
				
			||||||
| 
						 | 
					@ -51,6 +54,7 @@ For normal client usage, this is sufficient:
 | 
				
			||||||
)
 | 
					)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
puts result.data
 | 
					puts result.data
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## API Features
 | 
					## API Features
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -58,16 +62,22 @@ For normal client usage, this is sufficient:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To take full advantage of the client, load API definitions prior to use. To load an API:
 | 
					To take full advantage of the client, load API definitions prior to use. To load an API:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
urlshortener = client.discovered_api('urlshortener')
 | 
					urlshortener = client.discovered_api('urlshortener')
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Specific versions of the API can be loaded as well:
 | 
					Specific versions of the API can be loaded as well:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
drive = client.discovered_api('drive', 'v2')
 | 
					drive = client.discovered_api('drive', 'v2')
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Locally cached discovery documents may be used as well. To load an API from a local file:
 | 
					Locally cached discovery documents may be used as well. To load an API from a local file:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
doc = File.read('my-api.json')
 | 
					doc = File.read('my-api.json')
 | 
				
			||||||
my_api = client.register_discovery_document('myapi', 'v1', doc)
 | 
					my_api = client.register_discovery_document('myapi', 'v1', doc)
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Authorization
 | 
					### Authorization
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -77,6 +87,7 @@ Credentials can be managed at the connection level, as shown, or supplied on a p
 | 
				
			||||||
    
 | 
					    
 | 
				
			||||||
For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
 | 
					For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
 | 
					key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
 | 
				
			||||||
client.authorization = Signet::OAuth2::Client.new(
 | 
					client.authorization = Signet::OAuth2::Client.new(
 | 
				
			||||||
  :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
 | 
					  :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
 | 
				
			||||||
| 
						 | 
					@ -86,7 +97,7 @@ For server-to-server interactions, like those between a web application and Goog
 | 
				
			||||||
  :signing_key => key)
 | 
					  :signing_key => key)
 | 
				
			||||||
client.authorization.fetch_access_token!
 | 
					client.authorization.fetch_access_token!
 | 
				
			||||||
client.execute(...)
 | 
					client.execute(...)
 | 
				
			||||||
    
 | 
					```    
 | 
				
			||||||
    
 | 
					    
 | 
				
			||||||
### Batching Requests
 | 
					### Batching Requests
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -95,6 +106,7 @@ to bundle multiple requests together.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Example:
 | 
					Example:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
client = Google::APIClient.new
 | 
					client = Google::APIClient.new
 | 
				
			||||||
urlshortener = client.discovered_api('urlshortner')
 | 
					urlshortener = client.discovered_api('urlshortner')
 | 
				
			||||||
    
 | 
					    
 | 
				
			||||||
| 
						 | 
					@ -107,18 +119,22 @@ Example:
 | 
				
			||||||
batch.add(:api_method => urlshortener.url.insert, 
 | 
					batch.add(:api_method => urlshortener.url.insert, 
 | 
				
			||||||
          :body_object => { 'longUrl' => 'http://example.com/bar' })
 | 
					          :body_object => { 'longUrl' => 'http://example.com/bar' })
 | 
				
			||||||
client.execute(batch)
 | 
					client.execute(batch)
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
    
 | 
					    
 | 
				
			||||||
Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
 | 
					Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
 | 
					batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
 | 
				
			||||||
   puts result.data
 | 
					   puts result.data
 | 
				
			||||||
end
 | 
					end
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Media Upload
 | 
					### Media Upload
 | 
				
			||||||
 | 
					
 | 
				
			||||||
For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
 | 
					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
 | 
					uploads can be used. For example, to upload a file to Google Drive using multipart
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
drive = client.discovered_api('drive', 'v2')
 | 
					drive = client.discovered_api('drive', 'v2')
 | 
				
			||||||
   
 | 
					   
 | 
				
			||||||
media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
 | 
					media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
 | 
				
			||||||
| 
						 | 
					@ -130,10 +146,12 @@ uploads can be used. For example, to upload a file to Google Drive using multipa
 | 
				
			||||||
               :parameters => { 'uploadType' => 'multipart' },
 | 
					               :parameters => { 'uploadType' => 'multipart' },
 | 
				
			||||||
               :body_object => metadata,
 | 
					               :body_object => metadata,
 | 
				
			||||||
               :media => media )
 | 
					               :media => media )
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
   
 | 
					   
 | 
				
			||||||
To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
 | 
					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`.
 | 
					and continue if necessary, check `result.resumable_upload`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ruby
 | 
				
			||||||
client.execute(:api_method => drive.files.insert,
 | 
					client.execute(:api_method => drive.files.insert,
 | 
				
			||||||
           :parameters => { 'uploadType' => 'resumable' },
 | 
					           :parameters => { 'uploadType' => 'resumable' },
 | 
				
			||||||
           :body_object => metadata,
 | 
					           :body_object => metadata,
 | 
				
			||||||
| 
						 | 
					@ -144,11 +162,13 @@ and continue if necessary, check `result.resumable_upload`.
 | 
				
			||||||
if upload.resumable?
 | 
					if upload.resumable?
 | 
				
			||||||
    client.execute(upload)
 | 
					    client.execute(upload)
 | 
				
			||||||
end
 | 
					end
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Command Line
 | 
					## Command Line
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Included with the gem is a command line interface for working with Google APIs.
 | 
					Included with the gem is a command line interface for working with Google APIs.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
# Log in
 | 
					# Log in
 | 
				
			||||||
google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
 | 
					google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -160,6 +180,7 @@ Included with the gem is a command line interface for working with Google APIs.
 | 
				
			||||||
>> plus = $client.discovered_api('plus')
 | 
					>> plus = $client.discovered_api('plus')
 | 
				
			||||||
>> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
 | 
					>> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'})
 | 
				
			||||||
=> # returns a response from the API
 | 
					=> # returns a response from the API
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
For more information, use `google-api --help`
 | 
					For more information, use `google-api --help`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -171,6 +192,3 @@ See the full list of [samples on Google Code](http://code.google.com/p/google-ap
 | 
				
			||||||
## Support
 | 
					## 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).
 | 
					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).
 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue