gapic-common 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205d234f597f11bdd4853983740b20cc749d8c5f2983a0b80a7bb482c9b9c5ed
-  data.tar.gz: c32678b8d5094120cf9048ad829a899a15ec0f405188bf06f8f591f3912b7c47
+  metadata.gz: 9d5a60dd75b6fe30ba3654e69aa129b07c7a2159dff65134c9fd67ed8a598d70
+  data.tar.gz: c8cd0851a4f8f04dab553bf55bda12851cfdec0eaa9e1f6859c0e1a93f2555c7
 SHA512:
-  metadata.gz: f82e408a5e56f9aff64e1a160294029eaed2526b1f1c7fcda9b678d3718f9336cdfaf3fdcbf349953679d120e6d194d463c0173ec9a73f8363d4933ae9137e8f
-  data.tar.gz: 4ed55cc0b72bdb29fb898036f99d9e0b941609d123d0a53a594e4cc0052ca251f12840485c6e6218ba9640779d5cd51fadc1c86ae4ee23bb604eba9ced6c6d63
+  metadata.gz: e12310e5446b7dffa8a6c5cc3df4b0181414ae2e3118199d45b4cf2e54d1b61a7d72561634402ae319f66a0bcfa3786be67aaf4c8fb3e4a6e839ebdf27a58e64
+  data.tar.gz: 46752b4a1dee19463222b187de90071cf1a569ac83a8eabc13373f2d35460eb6a6f0ee681fbeab7165cebed0bf730d08cfe48da326d61c5fb5ef702fd6b020d1

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Release History
 
+### 0.4.0 / 2021-02-23
+
+* Support for the REST calls via the Gapic::Rest::ClientStub and other classes in Gapic::Rest
+  REST support is still being developed. Notably the full retries handling is not implemented yet.
+
+### 0.3.4 / 2020-08-07
+
+* Support the :this_channel_is_insecure gRPC pseudo-credential, used by tests and emulators.
+
+### 0.3.3 / 2020-08-05
+
+* Retry configs properly handle error name strings.
+
+### 0.3.2 / 2020-07-30
+
+* Alias PagedEnumerable#next_page to PagedEnumerable#next_page!
+
+### 0.3.1 / 2020-06-19
+
+* Fix file permissions
+
 ### 0.3.0 / 2020-06-18
 
 * Update the dependency on google-protobuf to 3.12.2

data/lib/gapic/call_options.rb

@@ -26,7 +26,9 @@ module Gapic
   #   @return [RetryPolicy, Object]
   #
   class CallOptions
-    attr_reader :timeout, :metadata, :retry_policy
+    attr_reader :timeout
+    attr_reader :metadata
+    attr_reader :retry_policy
 
     ##
     # Create a new Options object instance.

data/lib/gapic/call_options/retry_policy.rb

@@ -29,7 +29,7 @@ module Gapic
       # @param max_delay [Numeric] client-side timeout
       #
       def initialize retry_codes: nil, initial_delay: nil, multiplier: nil, max_delay: nil
-        @retry_codes   = retry_codes
+        @retry_codes   = convert_codes retry_codes
         @initial_delay = initial_delay
         @multiplier    = multiplier
         @max_delay     = max_delay
@@ -77,7 +77,7 @@ module Gapic
       def apply_defaults retry_policy
         return unless retry_policy.is_a? Hash
 
-        @retry_codes   ||= retry_policy[:retry_codes]
+        @retry_codes   ||= convert_codes retry_policy[:retry_codes]
         @initial_delay ||= retry_policy[:initial_delay]
         @multiplier    ||= retry_policy[:multiplier]
         @max_delay     ||= retry_policy[:max_delay]
@@ -85,6 +85,34 @@ module Gapic
         self
       end
 
+      # @private
+      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
+      # list of error codes.
+      ERROR_CODE_MAPPING = [
+        "OK",
+        "CANCELLED",
+        "UNKNOWN",
+        "INVALID_ARGUMENT",
+        "DEADLINE_EXCEEDED",
+        "NOT_FOUND",
+        "ALREADY_EXISTS",
+        "PERMISSION_DENIED",
+        "RESOURCE_EXHAUSTED",
+        "FAILED_PRECONDITION",
+        "ABORTED",
+        "OUT_OF_RANGE",
+        "UNIMPLEMENTED",
+        "INTERNAL",
+        "UNAVAILABLE",
+        "DATA_LOSS",
+        "UNAUTHENTICATED"
+      ].freeze
+
+      # @private
+      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.each_with_object({}) do |(str, num), hash|
+        hash[str] = num
+      end.freeze
+
       private
 
       def retry? error
@@ -96,6 +124,18 @@ module Gapic
         Kernel.sleep delay
       end
 
+      def convert_codes input_codes
+        return nil if input_codes.nil?
+        Array(input_codes).map do |obj|
+          case obj
+          when String
+            ERROR_STRING_MAPPING[obj]
+          when Integer
+            obj
+          end
+        end.compact
+      end
+
       ##
       # Calculate and set the next delay value.
       def increment_delay!

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.3.0".freeze
+    VERSION = "0.4.0".freeze
   end
 end

data/lib/gapic/config.rb

@@ -72,7 +72,7 @@ module Gapic
 
         if instance_variable_defined? :@parent_config
           parent = instance_variable_get :@parent_config
-          return parent.__send__ name if parent&.respond_to? name
+          return parent.__send__ name if parent.respond_to? name
         end
 
         default

data/lib/gapic/grpc/service_stub.rb

@@ -58,10 +58,11 @@ module Gapic
       channel_args = Hash channel_args
       interceptors = Array interceptors
 
-      @grpc_stub = if credentials.is_a? GRPC::Core::Channel
+      @grpc_stub = case credentials
+                   when GRPC::Core::Channel
                      grpc_stub_class.new endpoint, nil, channel_override: credentials,
                                                         interceptors:     interceptors
-                   elsif credentials.is_a? GRPC::Core::ChannelCredentials
+                   when GRPC::Core::ChannelCredentials, Symbol
                      grpc_stub_class.new endpoint, credentials, channel_args: channel_args,
                                                                 interceptors: interceptors
                    else

data/lib/gapic/grpc/service_stub/rpc_call.rb

@@ -122,9 +122,7 @@ module Gapic
           yield response, operation if block_given?
           response
         rescue StandardError => e
-          if check_retry? deadline
-            retry if options.retry_policy.call e
-          end
+          retry if check_retry?(deadline) && options.retry_policy.call(e)
 
           raise e
         end

data/lib/gapic/grpc/status_details.rb

@@ -27,13 +27,11 @@ module GRPC
       return nil.to_a if rpc_status.nil?
 
       rpc_status.details.map do |detail|
-        begin
-          detail_type = Google::Protobuf::DescriptorPool.generated_pool.lookup detail.type_name
-          detail = detail.unpack detail_type.msgclass if detail_type
-          detail
-        rescue Google::Protobuf::ParseError
-          detail
-        end
+        detail_type = Google::Protobuf::DescriptorPool.generated_pool.lookup detail.type_name
+        detail = detail.unpack detail_type.msgclass if detail_type
+        detail
+      rescue Google::Protobuf::ParseError
+        detail
       end
     end
   end

data/lib/gapic/paged_enumerable.rb

@@ -80,13 +80,11 @@ module Gapic
     #
     # @raise [RuntimeError] if it's not started yet.
     #
-    def each
+    def each &block
       return enum_for :each unless block_given?
 
       each_page do |page|
-        page.each do |obj|
-          yield obj
-        end
+        page.each(&block)
       end
     end
 
@@ -132,6 +130,7 @@ module Gapic
       end
       @page
     end
+    alias next_page next_page!
 
     ##
     # The page token to be used for the next RPC call.
@@ -200,7 +199,8 @@ module Gapic
     #   @return [GRPC::ActiveCall::Operation] the RPC operation for the page.
     class Page
       include Enumerable
-      attr_reader :response, :operation
+      attr_reader :response
+      attr_reader :operation
 
       ##
       # @private

data/lib/gapic/protobuf.rb

@@ -96,7 +96,7 @@ module Gapic
     #
     # @return [Array<Object>] The coerced version of the given values.
     def self.coerce_array array, field_descriptor
-      raise ArgumentError, "Value " + array.to_s + " must be an array" unless array.is_a? Array
+      raise ArgumentError, "Value #{array} must be an array" unless array.is_a? Array
       array.map do |val|
         coerce_value val, field_descriptor
       end

data/lib/gapic/rest.rb

@@ -0,0 +1,27 @@
+# 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.
+
+##
+# Rest GAPIC features are still under development.
+#
+
+require "faraday"
+require "gapic/call_options"
+require "gapic/common/version"
+require "gapic/headers"
+require "gapic/protobuf"
+require "gapic/rest/client_stub"
+require "gapic/rest/error"
+require "gapic/rest/faraday_middleware"
+require "json"

data/lib/gapic/rest/client_stub.rb

@@ -0,0 +1,126 @@
+# 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.
+
+require "googleauth"
+require "gapic/rest/faraday_middleware"
+
+module Gapic
+  module Rest
+    ##
+    # A class for making REST calls through Faraday
+    # ClientStub's responsibilities:
+    #   - wrap Faraday methods with a bounded explicit interface
+    #   - store service endpoint and create full url for the request
+    #   - store credentials and add auth information to the request
+    #
+    class ClientStub
+      ##
+      # Initializes with an endpoint and credentials
+      # @param endpoint [String] an endpoint for the service that this stub will send requests to
+      # @param credentials [Google::Auth::Credentials]
+      #   Credentials to send with calls in form of a googleauth credentials object.
+      #   (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+      #
+      # @yield [Faraday::Connection]
+      #
+      def initialize endpoint:, credentials:
+        @endpoint = endpoint
+        @endpoint = "https://#{endpoint}" unless /^https?:/.match? endpoint
+        @endpoint.sub! %r{/$}, ""
+
+        @credentials = credentials
+
+        @connection = Faraday.new url: @endpoint do |conn|
+          conn.headers = { "Content-Type" => "application/json" }
+          conn.request :google_authorization, @credentials
+          conn.request :retry
+          conn.response :raise_error
+          conn.adapter :net_http
+        end
+
+        yield @connection if block_given?
+      end
+
+      ##
+      # Makes a GET request
+      #
+      # @param uri [String] uri to send this request to
+      # @param params [Hash] query string parameters for the request
+      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
+      #   Currently only timeout and headers are supported.
+      # @return [Faraday::Response]
+      def make_get_request uri:, params: {}, options: {}
+        make_http_request :get, uri: uri, body: nil, params: params, options: options
+      end
+
+      ##
+      # Makes a DELETE request
+      #
+      # @param uri [String] uri to send this request to
+      # @param params [Hash] query string parameters for the request
+      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
+      #   Currently only timeout and headers are supported.
+      # @return [Faraday::Response]
+      def make_delete_request uri:, params: {}, options: {}
+        make_http_request :delete, uri: uri, body: nil, params: params, options: options
+      end
+
+      ##
+      # Makes a POST request
+      #
+      # @param uri [String] uri to send this request to
+      # @param body [String] a body to send with the request, nil for requests without a body
+      # @param params [Hash] query string parameters for the request
+      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
+      #   Currently only timeout and headers are supported.
+      # @return [Faraday::Response]
+      def make_post_request uri:, body:, params: {}, options: {}
+        make_http_request :post, uri: uri, body: body, params: params, options: options
+      end
+
+      ##
+      # Makes a PATCH request
+      #
+      # @param uri [String] uri to send this request to
+      # @param body [String] a body to send with the request, nil for requests without a body
+      # @param params [Hash] query string parameters for the request
+      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
+      #   Currently only timeout and headers are supported.
+      # @return [Faraday::Response]
+      def make_patch_request uri:, body:, params: {}, options: {}
+        make_http_request :patch, uri: uri, body: body, params: params, options: options
+      end
+
+      protected
+
+      ##
+      # Sends a http request via Faraday
+      # @param verb [Symbol] http verb
+      # @param uri [String] uri to send this request to
+      # @param body [String, nil] a body to send with the request, nil for requests without a body
+      # @param params [Hash] query string parameters for the request
+      # @param options [::Gapic::CallOptions] gapic options to be applied to the REST call.
+      #   Currently only timeout and headers are supported.
+      # @return [Faraday::Response]
+      def make_http_request verb, uri:, body:, params:, options:
+        @connection.send verb, uri do |req|
+          req.params = params if params.any?
+          req.body = body unless body.nil?
+          req.headers = req.headers.merge options.metadata
+          req.options.timeout = options.timeout if options.timeout&.positive?
+        end
+      end
+    end
+  end
+end

data/lib/gapic/rest/error.rb

@@ -0,0 +1,73 @@
+# 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.
+
+require "json"
+
+module Gapic
+  module Rest
+    # Gapic REST exception class
+    class Error < StandardError
+      # @return [Integer] the http status code for the error
+      attr_reader :status_code
+
+      ##
+      # @param message [String, nil] error message
+      # @param status_code [Integer, nil] HTTP status code of this error
+      #
+      def initialize message, status_code
+        @status_code = status_code
+        super message
+      end
+
+      class << self
+        ##
+        # This creates a new error message wrapping the Faraday's one. Additionally
+        # it tries to parse and set a detailed message and an error code from
+        # from the Google Cloud's response body
+        #
+        def wrap_faraday_error err
+          message = err.message
+          status_code = err.response_status
+
+          if err.response_body
+            msg, code = try_parse_from_body err.response_body
+            message = "An error has occurred when making a REST request: #{msg}" unless msg.nil?
+            status_code = code unless code.nil?
+          end
+
+          Gapic::Rest::Error.new message, status_code
+        end
+
+        private
+
+        ##
+        # Tries to get the error information from the JSON bodies
+        #
+        # @param body_str [String]
+        # @return [Array(String, String)]
+        def try_parse_from_body body_str
+          body = JSON.parse body_str
+          return [nil, nil] unless body && body["error"].is_a?(Hash)
+
+          message = body["error"]["message"]
+          code = body["error"]["code"]
+
+          [message, code]
+        rescue JSON::ParserError
+          [nil, nil]
+        end
+      end
+    end
+  end
+end

data/lib/gapic/rest/faraday_middleware.rb

@@ -0,0 +1,45 @@
+# 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.
+require "faraday"
+
+module Gapic
+  module Rest
+    # Registers the middleware with Faraday
+    module FaradayMiddleware
+      ##
+      # Request middleware that constructs the Authorization HTTP header
+      # using ::Google::Auth::Credentials
+      #
+      class GoogleAuthorization < Faraday::Middleware
+        ##
+        # @param app [#call]
+        # @param credentials [::Google::Auth::Credentials]
+        def initialize app, credentials
+          @credentials = credentials
+          super app
+        end
+
+        # @param env [Faraday::Env]
+        def call env
+          auth_hash = @credentials.client.apply({})
+          env.request_headers["Authorization"] = auth_hash[:authorization]
+
+          @app.call env
+        end
+      end
+
+      Faraday::Request.register_middleware google_authorization: -> { GoogleAuthorization }
+    end
+  end
+end

metadata

@@ -1,42 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: google-protobuf
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.2
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.12.2
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.9
+        version: 1.3.11
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -46,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.9
+        version: 1.3.11
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -56,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -66,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.6
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -76,28 +70,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.15.2
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '1.36'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '1.36'
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
@@ -118,14 +138,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +274,10 @@ files:
 - lib/gapic/operation/retry_policy.rb
 - lib/gapic/paged_enumerable.rb
 - lib/gapic/protobuf.rb
+- lib/gapic/rest.rb
+- lib/gapic/rest/client_stub.rb
+- lib/gapic/rest/error.rb
+- lib/gapic/rest/faraday_middleware.rb
 - lib/gapic/stream_input.rb
 homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses:
@@ -267,14 +291,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Common code for GAPIC-generated API clients