gapic-generator 0.1.4 → 0.2.3

data/lib/gapic/presenters/sample_presenter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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 "active_support/inflector"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for samples.
+    #
+    class SamplePresenter
+      def initialize api, sample_config
+        @api = api
+        @sample_config = sample_config
+      end
+
+      def description
+        @sample_config["description"]
+      end
+
+      def input_parameters
+        @sample_config["request"].select { |f| f.key? "input_parameter" }.map { |f| RequestField.new f }
+      end
+
+      def fields
+        dotted_hash = @sample_config["request"].each_with_object({}) do |f, memo|
+          memo[f["field"]] = f
+        end
+        dotted_hash.each_with_object({}) do |(path, f), memo|
+          parts = path.split "."
+          leaf_hash = parts[0...-1].inject(memo) { |h, k| h[k] ||= {} }
+          leaf_hash[parts.last] = RequestField.new f
+        end
+      end
+
+      def kwargs
+        fields.keys.map { |k| "#{k}: #{k}" }.join ", "
+      end
+
+      def response_raw
+        @sample_config["response"]
+      end
+
+      ##
+      # Representation of a request field.
+      #
+      class RequestField
+        attr_reader :field, :value, :input_parameter, :comment, :value_is_file
+        def initialize field
+          @field = field["field"]
+          @value = convert field["value"]
+          @input_parameter = field["input_parameter"]
+          @comment = field["comment"]
+          @comment = nil if @comment&.empty?
+          @value_is_file = field["value_is_file"]
+        end
+
+        protected
+
+        def convert val
+          if val.is_a? String
+            return ":#{val}" if val =~ /\A[A-Z_0-9]+\z/ # print constants as symbols
+            val.inspect
+          else
+            val.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gapic/presenters/service_presenter.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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 "active_support/inflector"
+require "gapic/helpers/filepath_helper"
+require "gapic/helpers/namespace_helper"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for proto services.
+    #
+    class ServicePresenter
+      include Gapic::Helpers::FilepathHelper
+      include Gapic::Helpers::NamespaceHelper
+
+      def initialize api, service, parent_service: nil
+        @api = api
+        @service = service
+        @parent_service = parent_service
+      end
+
+      def gem
+        GemPresenter.new @api
+      end
+
+      def file
+        FilePresenter.new @api, @service.parent
+      end
+
+      def package
+        PackagePresenter.new @api, @service.parent.package
+      end
+
+      def methods
+        @methods ||= begin
+          @service.methods.map { |m| MethodPresenter.new @api, m }
+        end
+      end
+
+      def address
+        @service.address
+      end
+
+      def namespace
+        return @service.ruby_package if @service.ruby_package.present?
+
+        namespace = ruby_namespace_for_address @service.address[0...-1]
+        fix_namespace @api, namespace
+      end
+
+      def version
+        ActiveSupport::Inflector.camelize @service.address[-2]
+      end
+
+      def doc_description disable_xrefs: false
+        @service.docs_leading_comments disable_xrefs: disable_xrefs
+      end
+
+      def name
+        @service.name
+      end
+
+      def proto_service_name_full
+        fix_namespace @api, "#{namespace}::#{name}"
+      end
+
+      def proto_service_file_path
+        @service.parent.name.sub ".proto", "_pb.rb"
+      end
+
+      def proto_service_file_name
+        proto_service_file_path.split("/").last
+      end
+
+      def proto_service_require
+        proto_service_file_path.sub ".rb", ""
+      end
+
+      def proto_services_file_path
+        @service.parent.name.sub ".proto", "_services_pb.rb"
+      end
+
+      def proto_services_file_name
+        proto_services_file_path.split("/").last
+      end
+
+      def proto_services_require
+        proto_services_file_path.sub ".rb", ""
+      end
+
+      def proto_service_stub_name_full
+        "#{proto_service_name_full}::Stub"
+      end
+
+      def service_file_path
+        service_require + ".rb"
+      end
+
+      def service_file_name
+        service_file_path.split("/").last
+      end
+
+      def service_require
+        ruby_file_path @api, proto_service_name_full
+      end
+
+      def client_name
+        "Client"
+      end
+
+      def client_name_full
+        fix_namespace @api, "#{proto_service_name_full}::#{client_name}"
+      end
+
+      def create_client_call
+        "#{client_name_full}.new"
+      end
+
+      def configure_client_call
+        "#{client_name_full}.configure"
+      end
+
+      def client_require
+        ruby_file_path @api, client_name_full
+      end
+
+      def client_file_path
+        client_require + ".rb"
+      end
+
+      def client_file_name
+        client_file_path.split("/").last
+      end
+
+      def client_endpoint
+        return @parent_service.client_endpoint if @parent_service
+        @service.host || default_config(:default_host) || "localhost"
+      end
+
+      def client_scopes
+        @service.scopes || default_config(:oauth_scopes)
+      end
+
+      def client_proto_name
+        @service.address.join "."
+      end
+
+      def credentials_name
+        "Credentials"
+      end
+
+      def credentials_name_full
+        fix_namespace @api, "#{proto_service_name_full}::#{credentials_name}"
+      end
+
+      def credentials_class_xref
+        "{#{credentials_name_full}}"
+      end
+
+      def credentials_file_path
+        credentials_require + ".rb"
+      end
+
+      def credentials_file_name
+        credentials_file_path.split("/").last
+      end
+
+      def credentials_require
+        ruby_file_path @api, credentials_name_full
+      end
+
+      def helpers_file_path
+        helpers_require + ".rb"
+      end
+
+      def helpers_file_name
+        "helpers.rb"
+      end
+
+      def helpers_require
+        ruby_file_path @api, "#{proto_service_name_full}::Helpers"
+      end
+
+      def references
+        @references ||= @service.resources.map { |resource| ResourcePresenter.new resource }.sort_by(&:name)
+      end
+
+      def paths?
+        references.any?
+      end
+
+      def paths_name
+        "Paths"
+      end
+
+      def paths_name_full
+        fix_namespace @api, "#{proto_service_name_full}::#{paths_name}"
+      end
+
+      def paths_file_path
+        paths_require + ".rb"
+      end
+
+      def paths_file_name
+        paths_file_path.split("/").last
+      end
+
+      def paths_require
+        ruby_file_path @api, "#{proto_service_name_full}::#{paths_name}"
+      end
+
+      def test_client_file_path
+        service_file_path.sub ".rb", "_test.rb"
+      end
+
+      def test_client_operations_file_path
+        service_file_path.sub ".rb", "_operations_test.rb"
+      end
+
+      def stub_name
+        "#{ActiveSupport::Inflector.underscore name}_stub"
+      end
+
+      def lro?
+        methods.find(&:lro?)
+      end
+
+      def lro_client_var
+        "operations_client"
+      end
+
+      def lro_client_ivar
+        "@#{lro_client_var}"
+      end
+
+      def operations_name
+        "Operations"
+      end
+
+      def operations_name_full
+        fix_namespace @api, "#{proto_service_name_full}::#{operations_name}"
+      end
+
+      def operations_file_path
+        operations_require + ".rb"
+      end
+
+      def operations_file_name
+        operations_file_path.split("/").last
+      end
+
+      def operations_require
+        ruby_file_path @api, "#{proto_service_name_full}::#{operations_name}"
+      end
+
+      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?
+      end
+
+      def config_channel_args
+        { "grpc.service_config_disable_resolution" => 1 }
+      end
+
+      def grpc_service_config
+        return unless @api.grpc_service_config&.service_level_configs&.key? grpc_full_name
+        @api.grpc_service_config.service_level_configs[grpc_full_name]
+      end
+
+      def grpc_full_name
+        @service.address.join "."
+      end
+
+      private
+
+      def default_config key
+        return unless @service.parent.parent.configuration[:defaults]
+        return unless @service.parent.parent.configuration[:defaults][:service]
+
+        @service.parent.parent.configuration[:defaults][:service][key]
+      end
+    end
+  end
+end

data/lib/gapic/resource_lookup.rb

@@ -42,7 +42,14 @@ module Gapic
     def service_resource_types
       @service_resource_types ||= begin
         @service.methods.flat_map do |method|
-          message_resource_types method.input
+          input_resource_types = message_resource_types method.input
+
+          if @api.generate_path_helpers_output?
+            output_resource_types = message_resource_types method.output
+            input_resource_types + output_resource_types
+          else
+            input_resource_types
+          end
         end.uniq
       end
     end

data/lib/gapic/schema/api.rb

@@ -53,6 +53,14 @@ module Gapic
         @files.each { |f| f.parent = self }
       end
 
+      def containing_api
+        self
+      end
+
+      def containing_file
+        nil
+      end
+
       def lookup address
         address = address.join "." if address.is_a? Array
         @files.each do |f|
@@ -200,6 +208,22 @@ module Gapic
         end
       end
 
+      # Whether the generate_path_helpers_output parameter was given in the configuration
+      def generate_path_helpers_output_defined?
+        configuration.key? :generate_path_helpers_output
+      end
+
+      # Sets the generate_path_helpers_output parameter in the configuration
+      def generate_path_helpers_output= value
+        configuration[:generate_path_helpers_output] = value
+      end
+
+      # Whether to generate path helpers for output as well as input messages
+      def generate_path_helpers_output?
+        # if not set in configuration, false by default
+        configuration[:generate_path_helpers_output] ||= false
+      end
+
       # Raw parsed json of the combined grpc service config files if provided
       # or an empty hash if no config was provided
       def grpc_service_config_raw

data/lib/gapic/schema/wrappers.rb

@@ -95,14 +95,33 @@ module Gapic
         @docs = docs
       end
 
+      # Returns the "root" of this schema.
+      # @return [Gapic::Schema::Api]
+      def containing_api
+        parent&.containing_api
+      end
+
+      # Returns the file containing this proto entity
+      # @return [Gapic::Schema::File]
+      def containing_file
+        parent&.containing_file
+      end
+
+      ##
       # Gets the cleaned up leading comments documentation
-      def docs_leading_comments
+      #
+      # @param disable_xrefs [Boolean] (default is `false`) Disable linking to
+      #   cross-references, and render them simply as text. This can be used if
+      #   it is known that the targets are not present in the current library.
+      # @return [String]
+      #
+      def docs_leading_comments disable_xrefs: false
         return nil if @docs.nil?
         return nil if @docs.leading_comments.empty?
 
         lines = @docs.leading_comments.each_line.to_a
         lines.map! { |line| line.start_with?(" ") ? line[1..-1] : line }
-        lines = FormattingUtils.escape_braces lines
+        lines = FormattingUtils.format_doc_lines containing_api, lines, disable_xrefs: disable_xrefs
         lines.join
       end
 
@@ -376,6 +395,10 @@ module Gapic
         @services.each { |m| m.parent = self }
       end
 
+      def containing_file
+        self
+      end
+
       def lookup address
         address = address.split(".").reject(&:empty?).join(".")
         @registry[address]