gapic-common 0.3.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d577e52554064fdda97228a6570313d8df9cc3d830ca75b0b43bfd1412a1222
-  data.tar.gz: 9ec865b1b777f308449320d2813745738af835c5289df0d4783739dac0310f4c
+  metadata.gz: f181f3deefc2a5b42d783327db4c51a7e415cd7d5e58e16354ea2703cdb89293
+  data.tar.gz: 8aebd8ac22c5f770c551a69a82e5bfc74d5d72c13448e8d66d12a182d1ff77b0
 SHA512:
-  metadata.gz: 71599558c7d1e83abfe002213b24c7089179e52c2e68214002293c0d936ca38283fd4f38e790a3c0ec4c77e228ed1e0083d1ca871c1eaaa43ae33cad7a00ff90
-  data.tar.gz: d148bf75ff9afed66dd27fd206db1aaaf9627f7ecfd87d0db0abd0090b984e3318e476aa95e719aa580b3dbac7772c5b6856914d66699b54c1dbf2821e37e019
+  metadata.gz: 1d8353989aaf3874d554ff160ee3d2504fa50f68a5627fb7bdb2b6b3f12941c3fb9ef677475ac0714fb7905750582ff3780ed7e6e976a890970e3ee12bdfa90b
+  data.tar.gz: 3c867837b3b3aaa608f0b456536cd6b091e865ef3f2e5e882662545b31d1f6da95853486ec5b1544493c16edf5b6634f0e69dc87bf7cff8244b61f5c16c05c60

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release History
 
+### 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.
+
+### 0.4.2 / 2021-06-07
+
+* Expand googleauth dependency to include 1.x
+* Add a REST PUT method helper to Gapic::Rest.
+
+### 0.4.1 / 2021-04-15
+
+* Provide a default value for the 'body' in the REST POST method in Gapic::Rest.
+
+### 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.

data/CONTRIBUTING.md

@@ -8,7 +8,7 @@ just a few small guidelines you need to follow.
 Contributions to this project must be accompanied by a Contributor License
 Agreement. You (or your employer) retain the copyright to your contribution;
 this simply gives us permission to use and redistribute your contributions as
-part of the project. Head over to <https://cla.developers.google.com/> to see
+part of the project. Head over to https://cla.developers.google.com/ to see
 your current agreements on file or to sign a new one.
 
 You generally only need to submit a CLA once, so if you've already submitted one

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/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.3.4".freeze
+    VERSION = "0.5.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/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/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/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
 
@@ -201,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,139 @@
+# 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 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
+
+      ##
+      # 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: nil, params: {}, options: {}
+        make_http_request :post, uri: uri, body: body, params: params, options: options
+      end
+
+      ##
+      # Makes a PUT 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_put_request uri:, body: nil, params: {}, options: {}
+        make_http_request :put, 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,103 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2021-06-15 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'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.9
+        version: 1.3.11
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.6
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.14'
 - !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,28 +132,28 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +268,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 +285,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.6
 signing_key: 
 specification_version: 4
 summary: Common code for GAPIC-generated API clients