gapic-common 0.4.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c317dee8aa769cec71d8bbac90f2dda4d550d5f499e2fe57cdd8ebc8c1f1e8f8
-  data.tar.gz: 6be1ba8f2f3c9cb6247b951e72516313ead43250463c5dc90939cc294dcbcea2
+  metadata.gz: e36d6760d01349ef15250fe390b8cc0414933810f1cceccf1a7eeb3b4e08cec7
+  data.tar.gz: 12873f51efd0b4eb733ca1487d06f6cb58fd4a5bfae3bb4d4921a717ddc41de4
 SHA512:
-  metadata.gz: b9f631f39da2577cf557c6ad617fefd56615274028e226bf68dcbb7bb56f3a1642a29a0bebe8c949b37c95360ce869c18d09a64bd8b8baaeee86be8a3918451f
-  data.tar.gz: 247fffcdbf8ef5571de60395600122ac408d89e68d9afa17e33afc2a58434311b6b523d0ae089175787906779ee7abe0247f45f67ba4e87a56b56cd36da896ac
+  metadata.gz: 60ff219975cb030aa4cc30fb991723725895c2af9aa3c26774f4b5942c5ebe98c48e4ba22b3dd43364446018cb8b831bb0bfbdf1440827dba614cf2b4c2d8c0f
+  data.tar.gz: 52bf0bb0d636441ab6cb8a7bff28548bb0a595f52f7fe998ed75afefedf8bb28edece71c95c57775caa0d08e5fdcd9cf2dc43da1c7eec81b94d670f17bb88fbf

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 0.6.1 / 2022-04-28
+
+* Fixed permissions for some files
+
+### 0.6.0 / 2021-07-22
+
+* Added helper for REST pagination
+
+### 0.5.0 / 2021-06-15
+
+* Provide a way to create `x-goog-api-client` headers with rest library version and/or without grpc library version
+
 ### 0.4.3 / 2021-06-10
 
 * Fix file permissions.

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.4.3".freeze
+    VERSION = "0.6.1".freeze
   end
 end

data/lib/gapic/headers.rb

@@ -26,17 +26,27 @@ module Gapic
     # @param gax_version [String] The Gapic version. Defaults to `Gapic::Common::VERSION`.
     # @param gapic_version [String] The Gapic version.
     # @param grpc_version [String] The GRPC version. Defaults to `GRPC::VERSION`.
-    def self.x_goog_api_client ruby_version: nil, lib_name: nil, lib_version: nil,
-                               gax_version: nil, gapic_version: nil, grpc_version: nil
+    # @param rest_version [String] The Rest Library (Faraday) version. Defaults to `Faraday::VERSION`.
+    # @param transports_version_send [Array] Which transports to send versions for.
+    #   Allowed values to contain are:
+    #     `:grpc` to send the GRPC library version (if defined)
+    #     `:rest` to send the REST library version (if defined)
+    #   Defaults to `[:grpc]`
+    def self.x_goog_api_client ruby_version: nil, lib_name: nil, lib_version: nil, gax_version: nil,
+                               gapic_version: nil, grpc_version: nil, rest_version: nil,
+                               transports_version_send: [:grpc]
+
       ruby_version ||= ::RUBY_VERSION
       gax_version  ||= ::Gapic::Common::VERSION
       grpc_version ||= ::GRPC::VERSION if defined? ::GRPC
+      rest_version ||= ::Faraday::VERSION if defined? ::Faraday
 
       x_goog_api_client_header = ["gl-ruby/#{ruby_version}"]
       x_goog_api_client_header << "#{lib_name}/#{lib_version}" if lib_name
       x_goog_api_client_header << "gax/#{gax_version}"
       x_goog_api_client_header << "gapic/#{gapic_version}" if gapic_version
-      x_goog_api_client_header << "grpc/#{grpc_version}" if grpc_version
+      x_goog_api_client_header << "grpc/#{grpc_version}" if grpc_version && transports_version_send.include?(:grpc)
+      x_goog_api_client_header << "rest/#{rest_version}" if rest_version && transports_version_send.include?(:rest)
       x_goog_api_client_header.join " ".freeze
     end
   end

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

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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2022-04-28 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:
@@ -292,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Common code for GAPIC-generated API clients