gapic-common 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f181f3deefc2a5b42d783327db4c51a7e415cd7d5e58e16354ea2703cdb89293
-  data.tar.gz: 8aebd8ac22c5f770c551a69a82e5bfc74d5d72c13448e8d66d12a182d1ff77b0
+  metadata.gz: 60a01e31b774ce16ba39c630c8a9e8271c18ae8a89de1bd6feddeff2c5027983
+  data.tar.gz: c173c35d2eeb3cbd1c7cf47769cba71deb464a95766a1939858027c22d766ed8
 SHA512:
-  metadata.gz: 1d8353989aaf3874d554ff160ee3d2504fa50f68a5627fb7bdb2b6b3f12941c3fb9ef677475ac0714fb7905750582ff3780ed7e6e976a890970e3ee12bdfa90b
-  data.tar.gz: 3c867837b3b3aaa608f0b456536cd6b091e865ef3f2e5e882662545b31d1f6da95853486ec5b1544493c16edf5b6634f0e69dc87bf7cff8244b61f5c16c05c60
+  metadata.gz: ee846671cdebbd8d02bd0679f8e789005ea138d9cfcf10cbfac4c5e98b90e47e41a5abfbf165c0002276b8dfb6a5fe97924761eac02c8d3aa36c077a28f581da
+  data.tar.gz: a77e8a6feddae4cdb13859739d29901184cba2aa8431132cd4f3ebf5289434cd3b53289aaccca3f5eeaa648e4d988cb65f15a6c3cf7ba463e63e5a94649d5aaa

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.5.0".freeze
+    VERSION = "0.6.0".freeze
   end
 end

data/lib/gapic/rest.rb

@@ -24,4 +24,6 @@ require "gapic/protobuf"
 require "gapic/rest/client_stub"
 require "gapic/rest/error"
 require "gapic/rest/faraday_middleware"
+require "gapic/rest/operation"
+require "gapic/rest/paged_enumerable"
 require "json"

data/lib/gapic/rest/operation.rb

@@ -0,0 +1,33 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Gapic
+  module Rest
+    ##
+    # A base class for the wrappers over the long-running operations to the response of a REST LRO method.
+    #
+    # @attribute [r] operation
+    #   @return [Object] The wrapped operation object.
+    class BaseOperation
+      attr_reader :operation
+
+      ##
+      # @private
+      # @param operation [Object] The wrapped operation object.
+      def initialize operation
+        @operation = operation
+      end
+    end
+  end
+end

data/lib/gapic/rest/paged_enumerable.rb

@@ -0,0 +1,225 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Gapic
+  module Rest
+    ##
+    # A class to provide the Enumerable interface to the response of a REST paginated method.
+    # PagedEnumerable assumes response message holds a list of resources and the token to the next page.
+    #
+    # PagedEnumerable provides the enumerations over the resource data, and also provides the enumerations over the
+    # pages themselves.
+    #
+    # @example normal iteration over resources.
+    #   paged_enumerable.each { |resource| puts resource }
+    #
+    # @example per-page iteration.
+    #   paged_enumerable.each_page { |page| puts page }
+    #
+    # @example Enumerable over pages.
+    #   paged_enumerable.each_page do |page|
+    #     page.each { |resource| puts resource }
+    #   end
+    #
+    # @example more exact operations over pages.
+    #   while some_condition()
+    #     page = paged_enumerable.page
+    #     do_something(page)
+    #     break if paged_enumerable.next_page?
+    #     paged_enumerable.next_page
+    #   end
+    #
+    # @attribute [r] page
+    #   @return [Page] The current page object.
+    #
+    class PagedEnumerable
+      include Enumerable
+
+      attr_reader :page
+
+      ##
+      # @private
+      # @param service_stub [Object] The REST service_stub with the baseline implementation for the wrapped method.
+      # @param method_name [Symbol] The REST method name that is being wrapped.
+      # @param request [Object] The request object.
+      # @param response [Object] The response object.
+      # @param options [Gapic::CallOptions] The options for making the RPC call.
+      # @param format_resource [Proc] A Proc object to format the resource object. The Proc should accept response as an
+      #   argument, and return a formatted resource object. Optional.
+      #
+      def initialize service_stub, method_name, resource_field_name, request, response, options, format_resource: nil
+        @service_stub = service_stub
+        @method_name = method_name
+        @resource_field_name = resource_field_name
+        @request = request
+        @response = response
+        @options = options
+        @format_resource = format_resource
+
+        @page = Page.new response, resource_field_name, format_resource: @format_resource
+      end
+
+      ##
+      # Iterate over the individual resources, automatically requesting new pages as needed.
+      #
+      # @yield [Object] Gives the resource objects in the stream.
+      #
+      # @return [Enumerator] if no block is provided
+      #
+      def each &block
+        return enum_for :each unless block_given?
+
+        each_page do |page|
+          page.each(&block)
+        end
+      end
+
+      ##
+      # Iterate over the pages.
+      #
+      # @yield [Page] Gives the pages in the stream.
+      #
+      # @return [Enumerator] if no block is provided
+      #
+      def each_page
+        return enum_for :each_page unless block_given?
+
+        loop do
+          break if @page.nil?
+          yield @page
+          next_page!
+        end
+      end
+
+      ##
+      # True if there is at least one more page of results.
+      #
+      # @return [Boolean]
+      #
+      def next_page?
+        !next_page_token.nil? && !next_page_token.empty?
+      end
+
+      ##
+      # Load the next page and set it as the current page.
+      # If there is no next page, sets nil as a current page.
+      #
+      # @return [Page, nil] the new page object.
+      #
+      def next_page!
+        unless next_page?
+          @page = nil
+          return @page
+        end
+
+        next_request = @request.dup
+        next_request.page_token = @page.next_page_token
+
+        @response = @service_stub.send @method_name, next_request, @options
+        @page = Page.new @response, @resource_field_name, format_resource: @format_resource
+      end
+      alias next_page next_page!
+
+      ##
+      # The page token to be used for the next RPC call, or the empty string if there is no next page.
+      # nil if the iteration is complete.
+      #
+      # @return [String, nil]
+      #
+      def next_page_token
+        @page&.next_page_token
+      end
+
+      ##
+      # The current response object, for the current page.
+      # nil if the iteration is complete.
+      #
+      # @return [Object, nil]
+      #
+      def response
+        @page&.response
+      end
+
+      ##
+      # A class to represent a page in a PagedEnumerable. This also implements Enumerable, so it can iterate over the
+      # resource elements.
+      #
+      # @attribute [r] response
+      #   @return [Object] the response object for the page.
+      class Page
+        include Enumerable
+        attr_reader :response
+
+        ##
+        # @private
+        # @param response [Object] The response object for the page.
+        # @param resource_field [String] The name of the field in response which holds the resources.
+        # @param format_resource [Proc, nil] A Proc object to format the resource object. Default nil (no formatting).
+        # The Proc should accept response as an argument, and return a formatted resource object. Optional.
+        #
+        def initialize response, resource_field, format_resource: nil
+          @response = response
+          @resource_field = resource_field
+          @format_resource = format_resource
+        end
+
+        ##
+        # Iterate over the resources.
+        #
+        # @yield [Object] Gives the resource objects in the page.
+        #
+        # @return [Enumerator] if no block is provided
+        #
+        def each
+          return enum_for :each unless block_given?
+
+          # We trust that the field exists and is an Enumerable
+          resources.each do |resource|
+            resource = @format_resource.call resource if @format_resource
+            yield resource
+          end
+        end
+
+        ##
+        # The page token to be used for the next RPC call, or the empty string if there is no next page.
+        #
+        # @return [String]
+        #
+        def next_page_token
+          @response.next_page_token
+        end
+
+        ##
+        # Whether the next_page_token exists and is not empty
+        #
+        # @return [Boolean]
+        #
+        def next_page_token?
+          !next_page_token.empty?
+        end
+
+        ##
+        # Resources in this page presented as an array.
+        # When the iterable is a protobuf map, the `.each |item|` gives just the keys
+        # to iterate like a normal hash it should be converted to an array first
+        #
+        # @return [Array]
+        #
+        def resources
+          @resources ||= @response[@resource_field].to_a
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -272,6 +272,8 @@ files:
 - lib/gapic/rest/client_stub.rb
 - lib/gapic/rest/error.rb
 - lib/gapic/rest/faraday_middleware.rb
+- lib/gapic/rest/operation.rb
+- lib/gapic/rest/paged_enumerable.rb
 - lib/gapic/stream_input.rb
 homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses: