google-api-client 0.8.7 → 0.9.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 670147e4e2c5fde1aed72ab3774aa74321e40512
-  data.tar.gz: f082392c923335d2de7da780fb694239ad3c745a
+  metadata.gz: 028a4cc7ea1dd004a24511d10bbc5f57901ab4c6
+  data.tar.gz: 3a2a4c1b22ddf53624736bd96c6be999798bb8b1
 SHA512:
-  metadata.gz: f4f6f24c0442e8801e8582a131b5c3bac060dbfc9542a326d8525b97b237df522faa3cf6e2b9ac0d0160915a30080ca33e0aeb2805541435a8574b3be4b04cab
-  data.tar.gz: 9a07c7aecac858ea22b2cb743bb508c890a07a0afb4f11e2e31cc32ef15c8902881e1c449007bb4e07d01ec7d04a3ce0c401de4eae8e5b2e271d45c981b37b7f
+  metadata.gz: 8195661fd5d8a642b7cee3296228ff82f460ad775e7c1432a7503fb9260f7ee60ecf2229d7a18111b977b3d9df1666f1693ed90842521dfde26a2cb7c4a82134
+  data.tar.gz: cc0a433396c213916086f277f1612c64755d19a0e40d91a669d175a5278e04cd8674730e9e5fb44873b85324965bedbe64fdfd639313a19b080f168eea6982e1

data/.gitignore

@@ -0,0 +1,20 @@
+._*
+.DS_Store
+.yardoc
+.bundle
+.rvmrc
+Gemfile.lock
+coverage
+doc
+heckling
+pkg
+specdoc
+wiki
+.google-api.yaml
+*.log
+
+#IntelliJ
+.idea
+*.iml
+atlassian*
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FormatString:
+  EnforcedStyle: sprintf

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-03-25 23:30:36 -0700 using RuboCop version 0.29.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 19
+Metrics/AbcSize:
+  Max: 79
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 220
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 99
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 127
+
+# Offense count: 18
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 43
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 14
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Style/Next:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.0.0
+  - 2.1
+  - jruby-9000
+env:
+  - RAILS_VERSION="~>3.2"
+  - RAILS_VERSION="~>4.0.0"
+  - RAILS_VERSION="~>4.1.0"
+  - RAILS_VERSION="~>4.2.0"
+script: "rake spec:all"
+before_install:
+ - sudo apt-get update
+ - sudo apt-get install idn
+notifications:
+  email:
+    recipients:
+      - sbazyl@google.com
+    on_success: change
+    on_failure: change

data/.yardopts

@@ -0,0 +1,12 @@
+--hide-void-return
+--no-private
+--verbose
+--markup-provider=redcarpet
+--markup=markdown
+lib/**/*.rb
+generated/**/*.rb
+-
+README.md
+MIGRATING.md
+CONTRIBUTING.md
+LICENSE

data/CHANGELOG.md

@@ -1,5 +1,8 @@
-# 0.8.7
-* Lock activesupport version to < 5.0
+# 0.9.0.pre1
+* WARNING: Please see [MIGRATING](MIGRATING.md) for important information.
+* API classes are now generated ahead of time instead of at runtime.
+* Drop support for Ruby versions < 2.0
+* Switch from Faraday to Hurley for HTTP client
 
 # 0.8.6
 * Use discovered 'rootUrl' as base URI for services
@@ -30,7 +33,7 @@
 * Batch requests with the service interface now inherit the service's connection
 * `register_discover_document` now returns the API instance
 * Added `:proxy` option to set Faraday's HTTP proxy setting
-* Added `:faraday_options` option to allow passthrough settings to Faraday connection
+* Added `:faraday_option` option to allow passthrough settings to Faraday connection
 * Drop 1.8.x support
 * This will be the last release with 1.9.x support
 

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# How to become a contributor and submit your own code
+
+## Contributor License Agreements
+
+We'd love to accept your sample apps and patches! Before we can take them, we
+have to jump a couple of legal hurdles.
+
+Please fill out either the individual or corporate Contributor License Agreement
+(CLA).
+
+  * If you are an individual writing original source code and you're sure you
+    own the intellectual property, then you'll need to sign an [individual CLA]
+    (http://code.google.com/legal/individual-cla-v1.0.html).
+  * If you work for a company that wants to allow you to contribute your work,
+    then you'll need to sign a [corporate CLA]
+    (http://code.google.com/legal/corporate-cla-v1.0.html).
+
+Follow either of the two links above to access the appropriate CLA and
+instructions for how to sign and return it. Once we receive it, we'll be able to
+accept your pull requests.
+
+## Contributing A Patch
+
+1. Submit an issue describing your proposed change to the repo in question.
+1. The repo owner will respond to your issue promptly.
+1. If your proposed change is accepted, and you haven't already done so, sign a
+   Contributor License Agreement (see details above).
+1. Fork the desired repo, develop and test your code changes.
+1. Ensure that your code is clear and comprehensible.
+1. Ensure that your code has an appropriate set of unit tests which all pass.
+1. Submit a pull request.

data/Gemfile

@@ -1,9 +1,35 @@
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in google-apis.gemspec
 gemspec
 
-gem 'jruby-openssl', :platforms => :jruby
+
+group :development do
+  gem 'bundler', '~> 1.7'
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3.1'
+  gem 'json_spec', '~> 1.1'
+  gem 'webmock', '~> 1.21'
+  gem 'simplecov', '~> 0.9'
+  gem 'coveralls', '~> 0.7.11'
+  gem 'rubocop', '~> 0.29'
+  gem 'launchy', '~> 2.4'
+end
+
+platforms :jruby do
+  group :development do
+  	gem 'jruby-openssl'
+  end
+end
+
+platforms :ruby do
+  group :development do
+    gem 'yard', '~> 0.8'
+    gem 'redcarpet', '~> 3.2'
+    gem 'github-markup', '~> 1.3'
+  end
+end
 
 if ENV['RAILS_VERSION']
   gem 'rails', ENV['RAILS_VERSION']
-end
+end

data/MIGRATING.md

@@ -0,0 +1,171 @@
+# Migrating from version `0.8.x` to `0.9`
+
+Many changes and improvements have been made to the `google-api-ruby-client`
+library to bring it to `0.9`. If you are starting a new project or haven't used
+this library before version `0.9`, see the [README][readme] to get started
+as you won't need to migrate anything.
+
+Code written against the `0.8.x` version of this library will not work with the `0.9`
+version without modification.
+
+## Discovery
+
+In `0.8.x` the library would "discover" APIs on the fly, introducing
+additional network calls and instability. That has been fixed in `0.9`.
+
+To get the `drive` client in `0.8.x` required this:
+
+```ruby
+require 'google/api_client'
+
+client = Google::APIClient.new
+drive = client.discovered_api('drive', 'v2')
+```
+
+In `0.9` the same thing can be accomplished like this:
+
+```ruby
+require 'google/apis/drive_v2'
+
+drive = Google::Apis::DriveV2::DriveService.new
+```
+
+All APIs are immediately accessible without requiring additional network calls or runtime code generation.
+
+## API Methods
+
+The calling style for API methods has changed. In `0.8.x` all calls were via a generic `execute` method. In `0.9`
+the generated services have fully defined method signatures for all available methods.
+
+To get a file using the Google Drive API in `0.8.x` required this:
+
+```ruby
+file = client.execute(:api_method => drive.file.get, :parameters => { 'id' => 'abc123' })
+```
+
+In `0.9` the same thing can be accomplished like this:
+
+```ruby
+file = drive.get_file('abc123')
+```
+
+Full API definitions including available methods, parameters, and data classes can be found in the `generated` directory.
+
+## Authorization
+
+In the 0.9 version of this library, the authentication and authorization code was moved
+to the new [googleauth](https://github.com/google/google-auth-library-ruby) library. While the new library provides
+significantly simpler APIs for some use cases, not all features have been migrated. Missing features
+are expected to be added by end of Q2 2015.
+
+The underlying [Signet](https://github.com/google/signet) is still used for authorization. OAuth 2 credentials obtained
+previously will continue to work with the `0.9` version. OAuth 1 is no longer supported.
+
+## Media uploads
+
+Media uploads are significantly simpler in `0.9`.
+
+The old `0.8.x` way of uploading media:
+
+```ruby
+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 )
+```
+
+The new way in `0.9` using `upload_source` and `content_type` parameters:
+
+```ruby
+metadata = {
+  title: 'My movie',
+  description: 'The best home movie ever made'
+}
+drive.insert_file(metadata, upload_source: 'mymovie.m4v', content_type: 'video/mp4')
+```
+
+`upload_source` can be either a path to a file, an `IO` stream, or a `StringIO` instance.
+
+Uploads are resumable and will be automatically retried if interrupted.
+
+## Media downloads
+
+`0.9` introduces support for media downloads (`alt=media`). To download content, use the `download_dest` parameter:
+
+```ruby
+drive.get_file('abc123', download_dest: '/tmp/myfile.txt')
+```
+
+`download_dest` may be either a path to a file or an `IO` stream.
+
+## Batch Requests
+
+The old `0.8.x` way of performing batch requests:
+
+```ruby
+client = Google::APIClient.new
+urlshortener = client.discovered_api('urlshortener')
+
+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)
+```
+
+In `0.9`, the equivalent code is:
+
+```ruby
+require 'google/apis/urlshortner_v1'
+
+urlshortener = Google::Apis::UrlshortenerV1::UrlshortenerService.new
+
+urlshortener.batch do |urlshortener|
+  urlshortner.insert_url({long_url: 'http://example.com/foo'}) do |res, err|
+    puts res
+  end
+  urlshortner.insert_url({long_url: 'http://example.com/bar'}) do |res, err|
+    puts res
+  end
+end
+```
+
+Or if sharing the same block:
+
+```ruby
+require 'google/apis/urlshortner_v1'
+
+urlshortener = Google::Apis::UrlshortenerV1::UrlshortenerService.new
+
+callback = lambda { |res, err| puts res }
+urlshortener.batch do |urlshortener|
+  urlshortner.insert_url({long_url: 'http://example.com/foo'}, &callback)
+  urlshortner.insert_url({long_url: 'http://example.com/bar'}, &callback)
+end
+```
+
+## JRuby
+
+Jruby 1.7.4 in 2.0 compatibility mode is supported. To enable for a specific script:
+
+```
+jruby --2.0 myscript.rb
+```
+
+Or set as the default:
+
+```
+export JRUBY_OPTS=--2.0
+```
+
+JRuby 9000 will be supported once released.
+

data/README.md

@@ -1,218 +1,226 @@
 # Google API Client
 
-<dl>
-  <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>
-  <dt>Authors</dt><dd>Bob Aman, <a href="mailto:sbazyl@google.com">Steven Bazyl</a></dd>
-  <dt>Copyright</dt><dd>Copyright © 2011 Google, Inc.</dd>
-  <dt>License</dt><dd>Apache 2.0</dd>
-</dl>
+## Alpha
 
-[![Build Status](https://secure.travis-ci.org/google/google-api-ruby-client.png)](http://travis-ci.org/google/google-api-ruby-client)
-[![Dependency Status](https://gemnasium.com/google/google-api-ruby-client.png)](https://gemnasium.com/google/google-api-ruby-client)
+This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible
+changes when necessary.
 
-## Description
+## Migrating from 0.8.x
 
-The Google API Ruby Client makes it trivial to discover and access supported
-APIs.
+Version 0.9 is not compatible with previous versions. See [MIGRATING](MIGRATING.md) for additional details on how to
+migrate to the latest version.
 
-## Alpha
+## Installation
+
+Add this line to your application's Gemfile:
 
-This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.
+```ruby
+gem 'google-api-client'
+```
 
-## Install
+And then execute:
 
-Be sure `https://rubygems.org/` is in your gem sources.
+    $ bundle
 
-For normal client usage, this is sufficient:
+Or install it yourself as:
 
-```bash
-$ gem install google-api-client
-```
+    $ gem install google-api-client
 
-## Example Usage
+## Usage
+
+### Basic usage
+
+To use an API, include the corresponding generated file and instantiate the service. For example to use the Drive API:
 
 ```ruby
-require 'google/api_client'
-require 'google/api_client/client_secrets'
-require 'google/api_client/auth/installed_app'
-
-# Initialize the client.
-client = Google::APIClient.new(
-  :application_name => 'Example Ruby application',
-  :application_version => '1.0.0'
-)
-
-# Initialize Google+ API. Note this will make a request to the
-# discovery service every time, so be sure to use serialization
-# in your production code. Check the samples for more details.
-plus = client.discovered_api('plus')
-
-# Load client secrets from your client_secrets.json.
-client_secrets = Google::APIClient::ClientSecrets.load
-
-# Run installed application flow. Check the samples for a more
-# complete example that saves the credentials between runs.
-flow = Google::APIClient::InstalledAppFlow.new(
-  :client_id => client_secrets.client_id,
-  :client_secret => client_secrets.client_secret,
-  :scope => ['https://www.googleapis.com/auth/plus.me']
-)
-client.authorization = flow.authorize
-
-# Make an API call.
-result = client.execute(
-  :api_method => plus.activities.list,
-  :parameters => {'collection' => 'public', 'userId' => 'me'}
-)
-
-puts result.data
+require 'google/apis/drive_v2'
+
+Drive = Google::Apis::DriveV2 # Alias the module
+drive = Drive::DriveService.new
+drive.authorization = authorization # See Googleauth or Signet libraries
+
+# Search for files in Drive (first page only)
+files = drive.list_files(q: "title contains 'finances'")
+files.items.each do |file|
+  puts file.title
+end
+
+# Upload a file
+metadata = Drive::File.new(title: 'My document')
+metadata = drive.insert_file(metadata, upload_source: 'test.txt', content_type: 'text/plain')
+
+# Download a file
+drive.get_file(metadata.id, download_dest: '/tmp/myfile.txt')
 ```
 
-## API Features
+### Media
+
+Methods that allow media operations have additional parameters to specify the upload source or download destination.
+
+For uploads, the `upload_source` parameter can be specified with either a path to a file, an `IO` stream, or `StringIO`
+instance.
+
+For downloads, the `download_dest` parameter can also be either a path to a file, an `IO` stream, or `StringIO` instance.
+
+Both uploads & downloads are resumable. If an error occurs during transmission the request will be automatically
+retried from the last received byte.
 
-### API Discovery
+### Errors & Retries
 
-To take full advantage of the client, load API definitions prior to use. To load an API:
+Retries are disabled by default, but enabling retries is strongly encouraged. The number of retries can be configured
+via `Google::Apis::RequestOptions`. Any number greater than 0 will enable retries.
+
+To enable retries for all services:
 
 ```ruby
-urlshortener = client.discovered_api('urlshortener')
+Google::Apis::RequestOptions.default.retries = 5
 ```
 
-Specific versions of the API can be loaded as well:
+With retries enabled globally, retries can be disabled for specific calls by including a retry value of 0 in the
+request options:
 
 ```ruby
-drive = client.discovered_api('drive', 'v2')
+drive.insert_file(metadata, upload_source: 'test.txt', content_type: 'text/plain', options: { retries: 0 })
 ```
 
-Locally cached discovery documents may be used as well. To load an API from a local file:
+When retries are enabled, if a server or rate limit error occurs during a request it is automatically retried with
+an exponentially increasing delay on subsequent retries. If a request can not be retried or if the maximum number
+of retries is exceeded, an exception is thrown.
 
-```ruby
-# Output discovery document to JSON
-File.open('my-api.json', 'w') do |f| f.puts MultiJson.dump(client.discovery_document('myapi', 'v1')) end
+### Callbacks
+
+A block an be specified when making calls. If present, the block will be called with the result or error, rather than
+returning the result from the call or raising the error. Example:
 
-# Read discovery document and load API
-doc = File.read('my-api.json')
-client.register_discovery_document('myapi', 'v1', doc)
-my_api = client.discovered_api('myapi', 'v1')
+```ruby
+# Search for files in Drive (first page only)
+drive.list_files(q: "title contains 'finances'") do |res, err|
+  if err
+    # Handle error
+  else
+    # Handle response
+  end
+end
 ```
 
-### Authorization
+This calling style is required when making batch requests as responses are not available until the entire batch
+is complete.
 
-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).
+### Batches
 
-Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
+Multiple requests can be batched together into a single HTTP request to reduce overhead. Batched calls are executed
+in parallel and the responses processed once all results are available
 
-For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
 
-As of version 0.8.3, service accounts can be configured using
-[Application Default Credentials][1], which rely on the credentials being
-available in a well-known location.  If the credentials are not present
-and it's being used on a Compute Engine VM,  it will use the VM's default credentials.
+```ruby
+# Fetch a bunch of files by ID
+ids = ['file_id_1', 'file_id_2', 'file_id_3', 'file_id_4']
+drive.batch do |drive|
+  ids.each do |id|
+    drive.get_file(id) do |res, err|
+      # Handle response
+    end
+  end
+end
+```
+
+Media operations -- uploads & downloads -- can not be included in batch with other requests.
+
+However, some APIs support batch uploads. To upload multiple files in a batch, use the `batch_upload` method instead.
+Batch uploads should only be used when uploading multiple small files. For large files, upload files individually to
+take advantage of the libraries built-in reusmable upload support.
+
+### Hashes
+
+While the API will always return instances of schema classes, plain hashes are accepted in method calls for
+convenience. Hash keys must be symbols matching the attribute names on the corresponding object the hash is meant
+to replace. For example:
 
 ```ruby
-client.authorization = :google_app_default  # in a later version, this will become the default
-client.authorization.fetch_access_token!
-client.execute(...)
+file = {id: '123', title: 'My document', labels: { starred: true }}
+file = drive.insert_file(file) # Returns a Drive::File instance
 ```
 
-This is simpler API to use than in previous versions, although that is still available:
+is equivalent to:
 
 ```ruby
-key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
-client.authorization = Signet::OAuth2::Client.new(
-  :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
-  :audience => 'https://accounts.google.com/o/oauth2/token',
-  :scope => 'https://www.googleapis.com/auth/prediction',
-  :issuer => '123456-abcdef@developer.gserviceaccount.com',
-  :signing_key => key)
-client.authorization.fetch_access_token!
-client.execute(...)
+file = Drive::File.new(id: '123', title: 'My document')
+file.labels = Drive::File::Labels.new(starred: true)
+file = drive.update_file(file) # Returns a Drive::File instance
 ```
 
-Service accounts are also used for delegation in Google Apps domains. The target user for impersonation is specified by setting the `:person` parameter to the user's email address
-in the credentials. Detailed instructions on how to enable delegation for your domain can be found at [developers.google.com](https://developers.google.com/drive/delegation).
+## Authorization
 
-### Automatic Retries & Backoff
+[OAuth 2](https://developers.google.com/accounts/docs/OAuth2) is used to authorize applications. This library uses
+both [Signet](https://github.com/google/signet) and
+[Google Auth Library for Ruby](https://github.com/google/google-auth-library-ruby) for OAuth 2 support.
 
-The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to
-the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry.
-In the case of authentication token expiry, the API client will attempt to refresh the token and retry the failed operation - this
-is a specific exception to the retry rules.
+The [Google Auth Library for Ruby](https://github.com/google/google-auth-library-ruby) provides an implementation of
+[application default credentials] for Ruby. It offers a simple way to get authorization credentials for use in
+calling Google APIs, best suited for cases when the call needs to have the same identity
+and authorization level for the application independent of the user. This is
+the recommended approach to authorize calls to Cloud APIs, particularly when
+you're building an application that uses Google Compute Engine.
 
-The default value for retries is 0, but will be enabled by default in future releases.
+For per-user authorization, use [Signet](https://github.com/google/signet) to obtain user authorization.
 
-### Batching Requests
+### Passing authorization to requests
 
-Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
-to bundle multiple requests together.
+Authorization can be specified for the entire client, for an individual service instance, or on a per-request basis.
 
-Example:
+Set authorization for all service:
 
 ```ruby
-client = Google::APIClient.new
-urlshortener = client.discovered_api('urlshortener')
+Google::Apis::RequestOptions.default.authorization = authorization
+# Services instantiated after this will inherit the authorization
+```
 
-batch = Google::APIClient::BatchRequest.new do |result|
-    puts result.data
-end
+On a per-service level:
+
+```ruby
+drive = Google::Apis::DriveV2::DriveService.new
+drive.authorization = authorization
 
-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)
+# All requests made with this service will use the same authorization
 ```
 
-Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
+Per-request:
 
 ```ruby
-batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
-   puts result.data
-end
+drive.get_file('123', options: { authorization: authorization })
 ```
 
-### Media Upload
+## Generating APIs
 
-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
+For [Cloud Endpoints](https://cloud.google.com/endpoints/) or other APIs not included in the gem, ruby code can be
+generated from the discovery document.
 
-```ruby
-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 generate from a local discovery file:
 
-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`.
+    $ generate-api gen <outdir> --file=<path>
 
-```ruby
-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
-```
+A URL can also be specified:
 
-## Samples
+    $ generate-api gen <outdir> --url=<url>
 
-See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-samples).
+## TODO
 
+*  ETag support (if-not-modified)
+*  Auto-paging results (maybe)
+*  Caching
+*  Model validations
 
-## Support
+## License
+
+This library is licensed under Apache 2.0. Full license text is
+available in [LICENSE.txt](LICENSE.txt).
+
+## Contributing
 
-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).
+See [CONTRIBUTING](contributing).
+
+## Support
 
-[1]: https://developers.google.com/accounts/docs/application-default-credentials
+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).