google-api-client 0.6.4 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25f7fed5190421b20ce39568ea716d2a5a52627e
+  data.tar.gz: f511d420725a7e69600d7654090d7794743c8591
+SHA512:
+  metadata.gz: 4a889315a2b6d96b6d56ac808880203c7dbe6c108a214c610440182e784162a93c753367d49d9cc16b22a50a8d2668e507590d45f6665c3227fe31faed8adf88
+  data.tar.gz: 49493d0cb5c148bd88962b1eaca02acba2f21bfc04ef115a6e75958f2677a386a6945698f3ea2054b2f3e635be08fc441441aef149f60aa880503809b7618d90

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.7.0
+* Remove CLI
+* SUpport for automatic retires & backoff. Off by default, enable by setting `retries` on `APIClient`
+* Experimental new interface (see `Google::APIClient::Service`)
+* Fix warnings when using Faraday separately
+* Support Google Compute Engine service accounts
+* Enable gzip compression for responses
+* Upgrade to Faraday 0.9.0. Resolves multiple issues with query parameter encodings.
+* Use bundled root certificates for verifying SSL certificates
+* Rewind media when retrying uploads
+
+# 0.6.4
+* Pin signet version to 0.4.x
+
 # 0.6.3
 
 * Update autoparse to 0.3.3 to fix cases where results aren't correctly parsed.

data/Gemfile

@@ -1,15 +1,16 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 
-gem 'signet', '~> 0.4.5'
+gem 'signet', '>= 0.5.0'
 gem 'addressable', '>= 2.3.2'
 gem 'uuidtools', '>= 2.1.0'
 gem 'autoparse', '>= 0.3.3'
-gem 'faraday', '~> 0.8.4'
+gem 'faraday', '>= 0.9.0'
 gem 'multi_json', '>= 1.0.0'
 gem 'extlib', '>= 0.9.15'
 gem 'jwt', '~> 0.1.5'
+gem 'retriable', '>= 1.4'
 gem 'jruby-openssl', :platforms => :jruby
 
 group :development do
@@ -18,14 +19,23 @@ group :development do
   gem 'kramdown'
 end
 
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+end
+
+
 group :examples do
   gem 'sinatra'
 end
 
 group :test, :development do
+  gem 'json', '~> 1.7.7'
   gem 'rake', '>= 0.9.0'
   gem 'rspec', '>= 2.11.0'
   gem 'rcov', '>= 0.9.9', :platform => :mri_18
 end
 
+
 gem 'idn', :platform => :mri_18

data/README.md

@@ -1,7 +1,7 @@
 # Google API Client
 
 <dl>
-  <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>
+  <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>
@@ -17,40 +17,52 @@ APIs.
 
 ## Install
 
-Be sure `http://rubygems.org/` is in your gem sources.
+Be sure `https://rubygems.org/` is in your gem sources.
 
 For normal client usage, this is sufficient:
 
-    $ sudo gem install google-api-client
+```bash
+$ gem install google-api-client
+```
 
 ## 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_ID_FROM_API_CONSOLE>'
-    client.authorization.client_secret = '<CLIENT_SECRET>'
-    client.authorization.redirect_uri = '<YOUR_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
+```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
+```
 
 ## API Features
 
@@ -58,36 +70,53 @@ For normal client usage, this is sufficient:
 
 To take full advantage of the client, load API definitions prior to use. To load an API:
 
-    urlshortener = client.discovered_api('urlshortener')
+```ruby
+urlshortener = client.discovered_api('urlshortener')
+```
 
 Specific versions of the API can be loaded as well:
 
-    drive = client.discovered_api('drive', 'v2')
+```ruby
+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)
+```ruby
+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). 
+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.
 
-    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(...)
-    
-    
+```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(...)
+```
+
+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).
+
+### Automatic Retries & Backoff
+
+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.
+
+The default value for retries is 0, but will be enabled by default in future releases.
+
 ### Batching Requests
 
 Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
@@ -95,82 +124,89 @@ 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)
-    
+```ruby
+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
+```ruby
+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`.
+```ruby
+drive = client.discovered_api('drive', 'v2')
 
-    client.execute(:api_method => drive.files.insert,
-               :parameters => { 'uploadType' => 'resumable' },
+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 )
-    upload = result.resumable_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`.
+
+```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
+# 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"
+```bash
+# 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"
+# 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
+# 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).
+See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-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).
-
-
-
+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).

data/Rakefile

@@ -11,7 +11,7 @@ PKG_DISPLAY_NAME   = 'Google API Client'
 PKG_NAME           = PKG_DISPLAY_NAME.downcase.gsub(/\s/, '-')
 PKG_VERSION        = Google::APIClient::VERSION::STRING
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-PKG_HOMEPAGE       = 'http://code.google.com/p/google-api-ruby-client/'
+PKG_HOMEPAGE       = 'https://github.com/google/google-api-ruby-client'
 
 RELEASE_NAME       = "REL #{PKG_VERSION}"