gapic-generator 0.5.1 → 0.6.4

data/lib/gapic/presenters/field_presenter.rb

@@ -80,6 +80,10 @@ module Gapic
         @field.enum?
       end
 
+      def proto3_optional?
+        @field.proto3_optional?
+      end
+
       def repeated?
         @field.repeated?
       end
@@ -88,6 +92,14 @@ module Gapic
         @field.map?
       end
 
+      def oneof?
+        @field.oneof?
+      end
+
+      def oneof_name
+        @message.oneof_decl[@field.oneof_index].name
+      end
+
       protected
 
       def field_doc_types field, output

data/lib/gapic/presenters/gem_presenter.rb

@@ -33,7 +33,7 @@ module Gapic
       def packages
         @packages ||= begin
           packages = @api.generate_files.map(&:package).uniq.sort
-          packages.map { |p| PackagePresenter.new @api, p }.delete_if(&:empty?)
+          packages.map { |p| PackagePresenter.new self, @api, p }.delete_if(&:empty?)
         end
       end
 
@@ -44,7 +44,7 @@ module Gapic
       def services
         @services ||= begin
           files = @api.generate_files
-          files.map(&:services).flatten.map { |s| ServicePresenter.new @api, s }
+          files.map(&:services).flatten.map { |s| ServicePresenter.new self, @api, s }
         end
       end
 
@@ -134,7 +134,17 @@ module Gapic
       end
 
       def api_id
-        gem_config :api_id
+        raw_id = gem_config :api_id
+        return nil unless raw_id
+        raw_id.include?(".") ? raw_id : "#{raw_id}.googleapis.com"
+      end
+
+      def api_shortname
+        gem_config :api_shortname
+      end
+
+      def issue_tracker_url
+        gem_config :issue_tracker_url
       end
 
       def free_tier?
@@ -147,10 +157,36 @@ module Gapic
         gem_config(:yard_strict) != "false"
       end
 
+      def generic_endpoint?
+        gem_config(:generic_endpoint) == "true"
+      end
+
       def entrypoint_require
         packages.first.package_require
       end
 
+      def license_name
+        "MIT"
+      end
+
+      def extra_files
+        ["README.md", "LICENSE.md", ".yardopts"]
+      end
+
+      def dependencies
+        deps = { "gapic-common" => "~> 0.3" }
+        deps["grpc-google-iam-v1"] = [">= 0.6.10", "< 2.0"] if iam_dependency?
+        extra_deps = gem_config :extra_dependencies
+        deps.merge! extra_deps if extra_deps
+        deps
+      end
+
+      def dependency_list
+        dependencies.to_a
+                    .map { |name, requirements| [name, Array(requirements)] }
+                    .sort_by { |name, _requirements| name }
+      end
+
       private
 
       def gem_config key

data/lib/gapic/presenters/method_presenter.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 require "active_support/inflector"
-require "gapic/path_template"
+require "gapic/uri_template"
 require "gapic/ruby_info"
 require "gapic/helpers/namespace_helper"
 
@@ -27,13 +27,14 @@ module Gapic
     class MethodPresenter
       include Gapic::Helpers::NamespaceHelper
 
-      def initialize api, method
+      def initialize service_presenter, api, method
+        @service_presenter = service_presenter
         @api = api
         @method = method
       end
 
       def service
-        ServicePresenter.new @api, @method.parent
+        @service_presenter
       end
 
       def name
@@ -91,6 +92,11 @@ module Gapic
         have_oneof = []
 
         @method.input.fields.each do |field|
+          unless field.oneof?
+            selected_fields << field
+            next
+          end
+
           idx = field.oneof_index
           selected_fields << field unless have_oneof.include? idx
           have_oneof << idx
@@ -193,8 +199,7 @@ module Gapic
       # @return [Array<String>] The segment key names.
       #
       def routing_params
-        segments = Gapic::PathTemplate.parse method_path
-        segments.select { |s| s.is_a? Gapic::PathTemplate::Segment }.map(&:name)
+        Gapic::UriTemplate.parse_arguments method_path
       end
 
       def routing_params?

data/lib/gapic/presenters/package_presenter.rb

@@ -27,13 +27,14 @@ module Gapic
       include Gapic::Helpers::FilepathHelper
       include Gapic::Helpers::NamespaceHelper
 
-      def initialize api, package
+      def initialize gem_presenter, api, package
+        @gem_presenter = gem_presenter
         @api = api
         @package = package
       end
 
       def gem
-        GemPresenter.new @api
+        @gem_presenter
       end
 
       def name
@@ -63,7 +64,7 @@ module Gapic
           normal_services = services.select { |s| @api.delegate_service_for(s).nil? }
           # But include common services that delegate to normal services in this package.
           common_services = normal_services.flat_map { |s| @api.common_services_for s }
-          (normal_services + common_services).map { |s| ServicePresenter.new @api, s }
+          (normal_services + common_services).map { |s| ServicePresenter.new @gem_presenter, @api, s }
         end
       end
 

data/lib/gapic/presenters/resource_presenter.rb

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "gapic/path_template"
+require "gapic/path_pattern"
 require "active_support/inflector"
 
 module Gapic
@@ -27,7 +27,7 @@ module Gapic
       def initialize resource
         @resource = resource
 
-        @patterns = resource.pattern.map { |template| PatternPresenter.new template }
+        @patterns = resource.pattern.map { |pattern| PatternPresenter.new pattern }
 
         # Keep only patterns that can be used to create path helpers
         @patterns.filter!(&:useful_for_helpers?)
@@ -53,59 +53,51 @@ module Gapic
       # A presenter for a particular pattern
       #
       class PatternPresenter
-        def initialize template
-          @template = template
-          @segments = Gapic::PathTemplate.parse template
-          @arguments = arg_segments.map(&:name)
+        def initialize pattern_string
+          @pattern = pattern_string
+          @parsed_pattern = Gapic::PathPattern.parse pattern_string
           @path_string = build_path_string
         end
 
-        attr_reader :template, :segments, :arguments, :path_string
+        attr_reader :pattern, :path_string
 
         def useful_for_helpers?
-          arg_segments.none?(&:nontrivial_pattern?) && arg_segments.none?(&:positional?)
+          !@parsed_pattern.positional_segments? && !@parsed_pattern.nontrivial_pattern_segments?
+        end
+
+        def arguments
+          @parsed_pattern.arguments
         end
 
         def formal_arguments
-          arguments.map { |arg| "#{arg}:" }.join ", "
+          @parsed_pattern.arguments.map { |name| "#{name}:" }.join ", "
         end
 
         def arguments_key
-          arguments.sort.join ":"
+          @parsed_pattern.arguments.sort.join ":"
         end
 
         def arguments_with_dummy_values
-          arguments.each_with_index.map { |arg, index| "#{arg}: \"value#{index}\"" }.join ", "
+          @parsed_pattern.arguments.each_with_index.map { |name, index| "#{name}: \"value#{index}\"" }.join ", "
         end
 
         def expected_path_for_dummy_values
-          index = -1
-          segments.map do |segment|
-            if segment.is_a? Gapic::PathTemplate::Segment
-              index += 1
-              "value#{index}"
+          index = 0
+          @parsed_pattern.segments.map do |segment|
+            if segment.provides_arguments?
+              segment_dummy_path = segment.expected_path_for_dummy_values index
+              index += segment.arguments.length
+              segment_dummy_path
             else
-              # Should be a String
-              segment
+              segment.pattern
             end
-          end.join
+          end.join "/"
         end
 
         private
 
-        def arg_segments
-          segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
-        end
-
         def build_path_string
-          segments.map do |segment|
-            if segment.is_a? Gapic::PathTemplate::Segment
-              "\#{#{segment.name}}"
-            else
-              # Should be a String
-              segment
-            end
-          end.join
+          @parsed_pattern.segments.map(&:path_string).join "/"
         end
       end
     end

data/lib/gapic/presenters/service_presenter.rb

@@ -27,14 +27,15 @@ module Gapic
       include Gapic::Helpers::FilepathHelper
       include Gapic::Helpers::NamespaceHelper
 
-      def initialize api, service, parent_service: nil
+      def initialize gem_presenter, api, service, parent_service: nil
+        @gem_presenter = gem_presenter
         @api = api
         @service = service
         @parent_service = parent_service
       end
 
       def gem
-        GemPresenter.new @api
+        @gem_presenter
       end
 
       def file
@@ -42,12 +43,12 @@ module Gapic
       end
 
       def package
-        PackagePresenter.new @api, @service.parent.package
+        PackagePresenter.new @gem_presenter, @api, @service.parent.package
       end
 
       def methods
         @methods ||= begin
-          @service.methods.map { |m| MethodPresenter.new @api, m }
+          @service.methods.map { |m| MethodPresenter.new self, @api, m }
         end
       end
 
@@ -60,7 +61,7 @@ module Gapic
       def common_service_delegate
         unless defined? @common_service_delegate
           delegate = @api.delegate_service_for @service
-          @common_service_delegate = delegate ? ServicePresenter.new(@api, delegate) : nil
+          @common_service_delegate = delegate ? ServicePresenter.new(@gem_presenter, @api, delegate) : nil
         end
         @common_service_delegate
       end
@@ -187,6 +188,7 @@ module Gapic
       end
 
       def client_endpoint
+        return nil if generic_endpoint?
         @parent_service&.client_endpoint ||
           common_service_delegate&.client_endpoint ||
           @service.host ||
@@ -194,10 +196,15 @@ module Gapic
           "localhost"
       end
 
+      def generic_endpoint?
+        gem.generic_endpoint?
+      end
+
       def client_scopes
         common_service_delegate&.client_scopes ||
           @service.scopes ||
-          default_config(:oauth_scopes)
+          default_config(:oauth_scopes) ||
+          []
       end
 
       def credentials_name
@@ -314,7 +321,7 @@ module Gapic
 
       def lro_service
         lro = @service.parent.parent.files.find { |file| file.name == "google/longrunning/operations.proto" }
-        return ServicePresenter.new @api, lro.services.first, parent_service: self unless lro.nil?
+        return ServicePresenter.new @gem_presenter, @api, lro.services.first, parent_service: self unless lro.nil?
       end
 
       def config_channel_args

data/lib/gapic/runner.rb

@@ -48,8 +48,10 @@ module Gapic
       output_files = generator.new(api).generate
 
       # Create and write the response
-      Google::Protobuf::Compiler::CodeGeneratorResponse.new \
+      response = Google::Protobuf::Compiler::CodeGeneratorResponse.new \
         file: output_files
+      response.supported_features = Google::Protobuf::Compiler::CodeGeneratorResponse::FEATURE_PROTO3_OPTIONAL
+      response
     end
 
     # Run protoc generation.

data/lib/gapic/schema/wrappers.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/formatting_utils"
+require "gapic/path_pattern"
 
 module Gapic
   module Schema
@@ -654,6 +655,15 @@ module Gapic
         field_behavior.include? Google::Api::FieldBehavior::OPTIONAL
       end
 
+      # Denotes a field as a part of oneof.
+      # oneof_index is an int field so it'll be 0 by default for every field
+      # and an index in the message's oneof table for the oneof fields
+      # but since the indexes in the message's oneof table start with 0 as well
+      # we need this to determine whether the field is a part of the oneof
+      def oneof?
+        @descriptor.field? :oneof_index
+      end
+
       # Denotes a field as required. This indicates that the field **must** be
       # provided as part of the request, and failure to do so will cause an
       # error (usually `INVALID_ARGUMENT`).
@@ -730,7 +740,8 @@ module Gapic
         :default_value,
         :oneof_index,
         :json_name,
-        :options
+        :options,
+        :proto3_optional?
       )
     end
 
@@ -761,30 +772,32 @@ module Gapic
     #   @return [Array<Gapic::Schema::ResourceDescriptor>] The resource
     #     descriptor.
     # @!attribute [r] parsed_patterns
-    #   @return [Array<Array<String>>] The normalized, segmented forms of the
-    #     patterns. Normalized means all ID segments are replaced by asterisks
+    #   @return [Array<String>] The template form of the
+    #     patterns. Template means all ID segments are replaced by asterisks
     #     to remove non-structural differences due to different names being
-    #     used. Segmented means simply split on slashes.
+    #     used.
     #     For example, if a pattern is `"projects/{project}""`, the
-    #     corresponding parsed pattern would be `["projects", "*"]`.
+    #     corresponding parsed pattern would be `"projects/*"]`.
+    # @!attribure [r] parsed_parent_patterns
+    #   return [Array<String>] Parsed patterns for the expected parents.
     # @!attribute [r] parent_resources
     #   @return [Array<Gapic::Schema::Resource>] Parent resources
     class Resource
       extend Forwardable
-      attr_reader :descriptor, :parsed_patterns, :parent_resources
+      attr_reader :descriptor, :parsed_patterns, :parsed_parent_patterns, :parent_resources
       attr_accessor :parent
 
       # Initializes a resource object.
-      # @param descriptor [Google::Protobuf::ResourceDescriptor] the protobuf
+      # @param descriptor [Google::Api::ResourceDescriptor] the protobuf
       #   representation of this resource.
       def initialize descriptor
         @parent = nil
         @descriptor = descriptor
-        @parsed_patterns = descriptor.pattern.map do |pattern|
-          pattern.split("/").map do |segment|
-            segment =~ %r{\{[^/\}]+(=[^\}]+)?\}} ? "*" : segment
-          end.freeze
+        patterns = descriptor.pattern.map do |pattern|
+          Gapic::PathPattern.parse pattern
         end.freeze
+        @parsed_patterns = patterns.map(&:template).compact.uniq.freeze
+        @parsed_parent_patterns = patterns.map(&:parent_template).compact.uniq.freeze
         @parent_resources = []
       end
 
@@ -800,15 +813,6 @@ module Gapic
         parent&.containing_file
       end
 
-      # Returns parsed patterns for the expected parents.
-      # @return [Array<Array<String>>]
-      def parsed_parent_patterns
-        @parsed_patterns.map do |pat|
-          parent = pat.last =~ /^\*\*?$/ ? pat[0...-2] : pat[0...-1]
-          parent.empty? ? nil : parent
-        end.compact.uniq
-      end
-
       # @!method type
       #   @return [String] the resource type string.
       # @!method pattern

data/lib/gapic/uri_template.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 "gapic/uri_template/parser"
+
+module Gapic
+  # TODO: Enter docs
+  # Dooooooooocs!!!
+  module UriTemplate
+    # Parse arguments from a URI template.
+    # @see https://tools.ietf.org/html/rfc6570 URI Template
+    #
+    # used to satisfy AIP-4222 Routing headers
+    # @see https://google.aip.dev/client-libraries/4222
+    #
+    # @param uri_template [String] The URI template to be parsed.
+    #
+    # @return [Array<String>] The arguments of the URI template.
+    def self.parse_arguments uri_template
+      Parser.parse_arguments uri_template
+    end
+  end
+end