google-api-client 0.8.3 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32e794e627d99cf204a2c62e8479fb6c62fba10b
-  data.tar.gz: 617cc09c435456fbcde61e58499538f787125c21
+  metadata.gz: 25d66ac8bb8cb858640f330178dac074a0557c83
+  data.tar.gz: 2d390abd07f9f816f15cdce0a6d32093ff73f3b6
 SHA512:
-  metadata.gz: 34e2ea99e0ef2ae2de28181077a9204a937b8bf0a25971f04584b06f5ab347d28d358623baf2d49dc8dc5808d5c459263fb9662cf3c6ae5ea93ca7c82ae78aa6
-  data.tar.gz: 15887c8abbc838a33cbfa560cfeb3d996e54c0b9f949c073daf9d15764514aa733a8f038f37622b01579ad64ac8ad30814ac7915606b5999ee98ed530b157a92
+  metadata.gz: 9f99549ac0f0d0f55b9072f7d75f5c8fec3e010b573d3752e867e4130eb0a40f7cf8c5a9a2d28d6b8571421ee4a405aa902b31878d8bb09c7eec846566eff87a
+  data.tar.gz: 870eb46ddef10fae48cb27c1446937087d58864fe0c77c1b3aec7cc043467353b7c46d5af072d00a653d708ea6300eb82f61630b099bfcf3e25f430ad3588b82

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,22 @@
+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: "bundle exec rake spec:all"
+before_install:
+ - sudo apt-get update
+ - sudo apt-get install idn
+ - gem update bundler
+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,3 +1,53 @@
+# 0.9
+* Force the use of alt=json for the groups settings API
+* Small tweaks to some calendar API and licensing API method names
+
+# 0.9.0.pre5
+* Change the default HTTP adapter to HTTPClient due to broken connections with long running uploads with Net::HTTP
+* No longer breaks Object#hash behavior, restores compatibility with Padrino
+* No longer omit falsey values (0, false, etc) in query parameters
+* Updated error messages to include the detailed/human friendly message
+* Allow Tempfile as an upload source
+* Updated samples for various APIs
+
+# 0.9.0.pre4
+* (Breaking change) Updated name method name generation for improved
+  consistency, some services may have changed.
+* Updated generated APIs
+* Fix streaming downloads with redirects
+* No longer swallow exceptions raised in blocks
+* Preserve query parameters in URLs when using `http()` for generic requests
+* Avoid masking errors caused by retries with resumable uploads
+* Deprecating the authorization support under Google::APIClient. Equivalent
+  functionality is now available in google-auth-library-ruby. These will
+  be removed in the 0.9 release.
+
+# 0.9.0.pre3
+* (Breaking change) Update method signatures to include required query
+  parameters in the list of non-keyword args
+
+# 0.9.0.pre2
+* Add raw HTTP status code & body to errors
+* Allow signet options to be passed in InstalledAppFlow.authorize
+* Update DateTime serialization to include milliseconds
+
+# 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
+* Respect discovered methods with colons in path
+
+# 0.8.5
+* Corrects the regression Rails 4 support in the 0.8.4 release.
+
+# 0.8.4
+* Fixes a file permission issues with the 0.8.3 release
+* Fixes warnings when the library is used
+
 # 0.8.3
 * Adds support for authorization via Application Default Credentials.
 # Adds support for tracking coverage on coveralls.io
@@ -10,13 +60,13 @@
 
 # 0.8.0
 * Refactored credential storage, added support for redis
-* Update gem depdendencies
+* Update gem dependencies
 * Fixed retry logic to allow for auth retries independent of the overall number of retries
 * Added `:force_encoding` option to set body content encoding based on the Content-Type header
 * 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,5 +1,39 @@
 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'
+  gem 'dotenv', '~> 2.0'
+  gem 'fakefs', '~> 0.6', require: "fakefs/safe"
+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'
+    gem 'pry-doc', '~> 0.8'
+    gem 'pry-byebug', '~> 3.2'
+  end
+end
+
+if ENV['RAILS_VERSION']
+  gem 'rails', ENV['RAILS_VERSION']
+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.md) 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.
+