google-api-client 0.9.3 → 0.9.4

data/generated/google/apis/site_verification_v1/service.rb

@@ -22,7 +22,7 @@ module Google
     module SiteVerificationV1
       # Google Site Verification API
       #
-      # Lets you programatically verify ownership of websites or domains with Google.
+      # Verifies ownership of websites or domains with Google.
       #
       # @example
       #    require 'google/apis/site_verification_v1'

data/generated/google/apis/storage_v1.rb

@@ -20,12 +20,12 @@ module Google
   module Apis
     # Cloud Storage JSON API
     #
-    # Lets you store and retrieve potentially-large, immutable data objects.
+    # Stores and retrieves potentially large, immutable data objects.
     #
     # @see https://developers.google.com/storage/docs/json_api/
     module StorageV1
       VERSION = 'V1'
-      REVISION = '20160210'
+      REVISION = '20160304'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/storage_v1/service.rb

@@ -22,7 +22,7 @@ module Google
     module StorageV1
       # Cloud Storage JSON API
       #
-      # Lets you store and retrieve potentially-large, immutable data objects.
+      # Stores and retrieves potentially large, immutable data objects.
       #
       # @example
       #    require 'google/apis/storage_v1'

data/generated/google/apis/tagmanager_v1.rb

@@ -20,12 +20,12 @@ module Google
   module Apis
     # Tag Manager API
     #
-    # API for accessing Tag Manager accounts and containers.
+    # Accesses Tag Manager accounts and containers.
     #
     # @see https://developers.google.com/tag-manager/api/v1/
     module TagmanagerV1
       VERSION = 'V1'
-      REVISION = '20160209'
+      REVISION = '20160310'
 
       # Delete your Google Tag Manager containers
       AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers'

data/generated/google/apis/tagmanager_v1/service.rb

@@ -22,7 +22,7 @@ module Google
     module TagmanagerV1
       # Tag Manager API
       #
-      # API for accessing Tag Manager accounts and containers.
+      # Accesses Tag Manager accounts and containers.
       #
       # @example
       #    require 'google/apis/tagmanager_v1'

data/generated/google/apis/vision_v1.rb

@@ -28,7 +28,7 @@ module Google
     # @see https://cloud.google.com/vision/
     module VisionV1
       VERSION = 'V1'
-      REVISION = '20160223'
+      REVISION = '20160308'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/vision_v1/classes.rb

@@ -757,7 +757,7 @@ module Google
         # @return [Google::Apis::VisionV1::BoundingPoly]
         attr_accessor :bounding_poly
       
-        # The location information for the recognized entity. Multiple
+        # The location information for the detected entity. Multiple
         # <code>LocationInfo</code> elements can be present since one location may
         # indicate the location of the scene in the query image, and another the
         # location of the place where the query image was taken. Location information
@@ -766,7 +766,7 @@ module Google
         # @return [Array<Google::Apis::VisionV1::LocationInfo>]
         attr_accessor :locations
       
-        # The accuracy of the entity recognition in an image.
+        # The accuracy of the entity detection in an image.
         # For example, for an image containing 'Eiffel Tower,' this field represents
         # the confidence that there is a tower in the query image. Range [0, 1].
         # Corresponds to the JSON property `confidence`

data/generated/google/apis/youtube_analytics_v1.rb

@@ -20,12 +20,12 @@ module Google
   module Apis
     # YouTube Analytics API
     #
-    # Retrieve your YouTube Analytics reports.
+    # Retrieves your YouTube Analytics reports.
     #
     # @see http://developers.google.com/youtube/analytics/
     module YoutubeAnalyticsV1
       VERSION = 'V1'
-      REVISION = '20160204'
+      REVISION = '20160301'
 
       # Manage your YouTube account
       AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'

data/generated/google/apis/youtube_analytics_v1/service.rb

@@ -22,7 +22,7 @@ module Google
     module YoutubeAnalyticsV1
       # YouTube Analytics API
       #
-      # Retrieve your YouTube Analytics reports.
+      # Retrieves your YouTube Analytics reports.
       #
       # @example
       #    require 'google/apis/youtube_analytics_v1'

data/generated/google/apis/youtube_v3.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://developers.google.com/youtube/v3
     module YoutubeV3
       VERSION = 'V3'
-      REVISION = '20160201'
+      REVISION = '20160222'
 
       # Manage your YouTube account
       AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'

data/generated/google/apis/youtube_v3/classes.rb

@@ -925,6 +925,7 @@ module Google
         attr_accessor :localizations
       
         # Basic details about a channel, including title, description and thumbnails.
+        # Next available id: 15.
         # Corresponds to the JSON property `snippet`
         # @return [Google::Apis::YoutubeV3::ChannelSnippet]
         attr_accessor :snippet
@@ -1711,6 +1712,7 @@ module Google
       end
       
       # Basic details about a channel, including title, description and thumbnails.
+      # Next available id: 15.
       class ChannelSnippet
         include Google::Apis::Core::Hashable
       
@@ -1719,6 +1721,11 @@ module Google
         # @return [String]
         attr_accessor :country
       
+        # The custom url of the channel.
+        # Corresponds to the JSON property `customUrl`
+        # @return [String]
+        attr_accessor :custom_url
+      
         # The language of the channel's default title and description.
         # Corresponds to the JSON property `defaultLanguage`
         # @return [String]
@@ -1757,6 +1764,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @country = args[:country] if args.key?(:country)
+          @custom_url = args[:custom_url] if args.key?(:custom_url)
           @default_language = args[:default_language] if args.key?(:default_language)
           @description = args[:description] if args.key?(:description)
           @localized = args[:localized] if args.key?(:localized)

data/generated/google/apis/youtube_v3/representations.rb

@@ -1494,6 +1494,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :country, as: 'country'
+          property :custom_url, as: 'customUrl'
           property :default_language, as: 'defaultLanguage'
           property :description, as: 'description'
           property :localized, as: 'localized', class: Google::Apis::YoutubeV3::ChannelLocalization, decorator: Google::Apis::YoutubeV3::ChannelLocalization::Representation

data/generated/google/apis/youtubereporting_v1.rb

@@ -20,13 +20,13 @@ module Google
   module Apis
     # YouTube Reporting API
     #
-    # An API to schedule reporting jobs and download the resulting bulk data reports
-    # about YouTube channels, videos etc. in the form of CSV files.
+    # Schedules reporting jobs and downloads the resulting bulk data reports about
+    # YouTube channels, videos, etc. in the form of CSV files.
     #
     # @see https://developers.google.com/youtube/reporting/v1/reports/
     module YoutubereportingV1
       VERSION = 'V1'
-      REVISION = '20151026'
+      REVISION = '20160301'
 
       # View monetary and non-monetary YouTube Analytics reports for your YouTube content
       AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly'

data/generated/google/apis/youtubereporting_v1/classes.rb

@@ -107,8 +107,7 @@ module Google
         # @return [String]
         attr_accessor :report_type_id
       
-        # The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this
-        # will actually be used for
+        # The name of the job (max. 100 characters).
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name

data/generated/google/apis/youtubereporting_v1/service.rb

@@ -22,8 +22,8 @@ module Google
     module YoutubereportingV1
       # YouTube Reporting API
       #
-      # An API to schedule reporting jobs and download the resulting bulk data reports
-      #  about YouTube channels, videos etc. in the form of CSV files.
+      # Schedules reporting jobs and downloads the resulting bulk data reports about
+      #  YouTube channels, videos, etc. in the form of CSV files.
       #
       # @example
       #    require 'google/apis/youtubereporting_v1'
@@ -50,8 +50,8 @@ module Google
         # Method for media download. Download is supported on the URI `/v1/media/`+name`?
         # alt=media`.
         # @param [String] resource_name
-        #   Name of the media that is being downloaded. See [][ByteStream.ReadRequest.
-        #   resource_name].
+        #   Name of the media that is being downloaded. See ByteStream.ReadRequest.
+        #   resource_name.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

data/lib/google/apis/core/base_service.rb

@@ -28,6 +28,53 @@ require 'hurley/addressable'
 module Google
   module Apis
     module Core
+      # Helper class for enumerating over a result set requiring multiple fetches
+      class PagedResults
+        include Enumerable
+
+        attr_reader :last_result
+
+        # @param [BaseService] service
+        #   Current service instance
+        # @param [Fixnum] max
+        #   Maximum number of items to iterate over. Nil if no limit
+        # @param [Boolean] cache
+        #  True (default) if results should be cached so multiple iterations can be used.
+        # @param [Symbol] items
+        #   Name of the field in the result containing the items. Defaults to :items
+        def initialize(service, max: nil, items: :items, cache: true, &block)
+          @service = service
+          @block = block
+          @max = max
+          @items_field = items
+          if cache
+            @result_cache = Hash.new do |h, k|
+              h[k] = @block.call(k, @service)
+            end
+            @fetch_proc = Proc.new { |token| @result_cache[token] }
+          else
+            @fetch_proc = Proc.new { |token| @block.call(token, @service) }
+          end
+        end
+
+        # Iterates over result set, fetching additional pages as needed
+        def each
+          page_token = nil
+          item_count = 0
+          loop do
+            @last_result = @fetch_proc.call(page_token)
+            for item in @last_result.send(@items_field)
+              item_count = item_count + 1
+              break if @max && item_count > @max
+              yield item
+            end
+            break if @max && item_count >= @max
+            break if @last_result.next_page_token.nil? || @last_result.next_page_token == page_token
+            page_token = @last_result.next_page_token
+          end
+        end
+      end
+
       # Base service for all APIs. Not to be used directly.
       #
       class BaseService
@@ -90,12 +137,12 @@ module Google
         # request to the server.
         #
         # @example
-        #   service.batch do |service|
-        #     service.get_item(id1) do |res, err|
+        #   service.batch do |s|
+        #     s.get_item(id1) do |res, err|
         #       # process response for 1st call
         #     end
         #     # ...
-        #     service.get_item(idN) do |res, err|
+        #     s.get_item(idN) do |res, err|
         #       # process response for Nth call
         #     end
         #   end
@@ -122,12 +169,12 @@ module Google
         # files, use single requests which use a resumable upload protocol.
         #
         # @example
-        #   service.batch do |service|
-        #     service.insert_item(upload_source: 'file1.txt') do |res, err|
+        #   service.batch do |s|
+        #     s.insert_item(upload_source: 'file1.txt') do |res, err|
         #       # process response for 1st call
         #     end
         #     # ...
-        #     service.insert_item(upload_source: 'fileN.txt') do |res, err|
+        #     s.insert_item(upload_source: 'fileN.txt') do |res, err|
         #       # process response for Nth call
         #     end
         #   end
@@ -191,6 +238,37 @@ module Google
           execute_or_queue_command(command, &block)
         end
 
+        # Executes a given query with paging, automatically retrieving
+        # additional pages as necessary. Requires a block that returns the
+        # result set of a page. The current page token is supplied as an argument
+        # to the block.
+        #
+        # Note: The returned enumerable also contains a `last_result` field
+        # containing the full result of the last query executed.
+        #
+        # @param [Fixnum] max
+        #   Maximum number of items to iterate over. Defaults to nil -- no upper bound.
+        # @param [Symbol] items
+        #   Name of the field in the result containing the items. Defaults to :items
+        # @param [Boolean] cache
+        #  True (default) if results should be cached so multiple iterations can be used.
+        # @return [Enumerble]
+        # @yield [token, service]
+        #   Current page token & service instance
+        # @yieldparam [String] token
+        #   Current page token to be used in the query
+        # @yieldparm [service]
+        #   Current service instance
+        # @since 0.9.4
+        #
+        # @example Retrieve all files,
+        #   file_list = service.fetch_all { |token, s| s.list_files(page_token: token) }
+        #   file_list.each { |f| ... }
+        def fetch_all(max: nil, items: :items, cache: true,  &block)
+          fail "fetch_all may not be used inside a batch" if batch?
+          return PagedResults.new(self, max: max, items: items, cache: cache, &block)
+        end
+
         protected
 
         # Create a new upload command.

data/lib/google/apis/version.rb

@@ -15,7 +15,7 @@
 module Google
   module Apis
     # Client library version
-    VERSION = '0.9.3'
+    VERSION = '0.9.4'
 
     # Current operating system
     # @private

data/script/generate

@@ -30,6 +30,7 @@ APIS=(adexchangebuyer:v1.4 \
 	cloudlatencytest:v2 \
 	cloudmonitoring:v2beta2 \
 	cloudresourcemanager:v1beta1 \
+	cloudresourcemanager:v1 \
 	cloudtrace:v1 \
 	clouduseraccounts:beta \
 	compute:v1 \
@@ -58,6 +59,7 @@ APIS=(adexchangebuyer:v1.4 \
 	gmail:v1 \
 	groupsmigration:v1 \
 	groupssettings:v1 \
+	iam:v1 \
 	identitytoolkit:v3 \
 	kgsearch:v1 \
 	licensing:v1 \

data/spec/google/apis/core/service_spec.rb

@@ -17,6 +17,7 @@ require 'google/apis/options'
 require 'google/apis/core/base_service'
 require 'google/apis/core/json_representation'
 require 'hurley/test'
+require 'ostruct'
 
 RSpec.describe Google::Apis::Core::BaseService do
   include TestHelpers
@@ -243,5 +244,70 @@ EOF
         end
       end.to raise_error(Google::Apis::ClientError)
     end
+
+    context 'with fetch_all' do
+      let(:responses) do
+        data = {}
+        data[nil] = OpenStruct.new(next_page_token: 'p1', items: ['a', 'b', 'c'], alt_items: [1, 2 , 3])
+        data['p1'] = OpenStruct.new(next_page_token: 'p2', items: ['d', 'e', 'f'], alt_items: [4, 5, 6])
+        data['p2'] = OpenStruct.new(next_page_token: nil, items: ['g', 'h', 'i'], alt_items: [7,8, 9])
+        data
+      end
+
+      let(:items) { service.fetch_all { |token| responses[token] } }
+
+      it 'should fetch pages until next page token is nil' do
+        expect(items).to contain_exactly('a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i')
+      end
+
+      it 'should stop on repeated page token' do
+        responses['p2'].next_page_token = 'p2'
+        expect(items).to contain_exactly('a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i')
+      end
+
+      it 'should allow selecting another field for items' do
+        expect(service.fetch_all(items: :alt_items) { |token| responses[token] } ).to contain_exactly(1, 2, 3, 4, 5, 6, 7, 8, 9)
+      end
+
+      it 'should allow limiting the number of items to fetch' do
+        expect(service.fetch_all(max: 5) { |token| responses[token] } ).to contain_exactly('a', 'b', 'c', 'd', 'e')
+      end
+
+      it 'should yield the next token' do
+        expect do |b|
+          service.fetch_all do |token|
+            b.to_proc.call(token)
+            responses[token]
+          end.count
+        end.to yield_successive_args(nil, 'p1', 'p2')
+      end
+
+      it 'should cache results' do
+        count = 0
+        items = service.fetch_all do |token|
+          count = count + 1
+          responses[token]
+        end
+
+        items.each{ |i| puts i }
+        items.each{ |i| puts i }
+
+        expect(count).to eq 3
+      end
+
+      it 'should allow disabling caching' do
+        count = 0
+        items = service.fetch_all(cache: false) do |token|
+          count = count + 1
+          responses[token]
+        end
+
+        items.each{ |i| puts i }
+        items.each{ |i| puts i }
+
+        expect(count).to eq 6
+      end
+
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-api-client
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Steven Bazyl
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -275,6 +275,10 @@ files:
 - generated/google/apis/cloudmonitoring_v2beta2/classes.rb
 - generated/google/apis/cloudmonitoring_v2beta2/representations.rb
 - generated/google/apis/cloudmonitoring_v2beta2/service.rb
+- generated/google/apis/cloudresourcemanager_v1.rb
+- generated/google/apis/cloudresourcemanager_v1/classes.rb
+- generated/google/apis/cloudresourcemanager_v1/representations.rb
+- generated/google/apis/cloudresourcemanager_v1/service.rb
 - generated/google/apis/cloudresourcemanager_v1beta1.rb
 - generated/google/apis/cloudresourcemanager_v1beta1/classes.rb
 - generated/google/apis/cloudresourcemanager_v1beta1/representations.rb
@@ -407,6 +411,10 @@ files:
 - generated/google/apis/groupssettings_v1/classes.rb
 - generated/google/apis/groupssettings_v1/representations.rb
 - generated/google/apis/groupssettings_v1/service.rb
+- generated/google/apis/iam_v1.rb
+- generated/google/apis/iam_v1/classes.rb
+- generated/google/apis/iam_v1/representations.rb
+- generated/google/apis/iam_v1/service.rb
 - generated/google/apis/identitytoolkit_v3.rb
 - generated/google/apis/identitytoolkit_v3/classes.rb
 - generated/google/apis/identitytoolkit_v3/representations.rb