gapic-generator 0.1.1

data/templates/default/helpers/presenters/package_presenter.rb

@@ -0,0 +1,65 @@
+# 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_relative "gem_presenter"
+require_relative "service_presenter"
+
+class PackagePresenter
+  include FilepathHelper
+  include NamespaceHelper
+
+  def initialize api, package
+    @api = api
+    @package = package
+  end
+
+  def gem
+    GemPresenter.new @api
+  end
+
+  def name
+    @package
+  end
+
+  def namespace
+    return services.first&.namespace if services.first&.namespace
+    ruby_namespace_for_address address
+  end
+
+  def services
+    @services ||= begin
+      files = @api.generate_files.select { |f| f.package == @package }
+      files.map(&:services).flatten.map { |s| ServicePresenter.new @api, s }
+    end
+  end
+
+  def address
+    @package.split "."
+  end
+
+  def package_require
+    ruby_file_path @api, namespace
+  end
+
+  def package_file_path
+    package_require + ".rb"
+  end
+
+  def empty?
+    services.empty?
+  end
+end

data/templates/default/helpers/presenters/resource_presenter.rb

@@ -0,0 +1,92 @@
+# 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 "gapic/path_template"
+require "ostruct"
+require "active_support/inflector"
+
+class ResourcePresenter
+  # @param resource [Google::Api::ResourceDescriptor]
+  def initialize resource
+    @resource = resource
+
+    @patterns = resource.pattern.map do |template|
+      segments = Gapic::PathTemplate.parse template
+      OpenStruct.new(
+        template:    template,
+        segments:    segments,
+        arguments:   arguments_for(segments),
+        path_string: path_string_for(segments)
+      )
+    end
+
+    @patterns.each do |pattern|
+      # URI path template verification for expected proto resource usage
+      if named_arg_patterns? pattern.segments
+        raise ArgumentError, "only resources without named patterns are supported, " \
+                             " not #{pattern.template}"
+      elsif positional_args? pattern.segments
+        raise ArgumentError, "only resources with named segments are supported, " \
+                             " not #{pattern.template}"
+      end
+    end
+  end
+
+  def name
+    @resource.type.split("/").delete_if(&:empty?).last
+  end
+
+  def type
+    @resource.type
+  end
+
+  def patterns
+    @patterns
+  end
+
+  def path_helper
+    "#{ActiveSupport::Inflector.underscore name}_path"
+  end
+
+  private
+
+  def arguments_for segments
+    arg_segments(segments).map(&:name)
+  end
+
+  def arg_segments segments
+    segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
+  end
+
+  def path_string_for segments
+    segments.map do |segment|
+      if segment.is_a? Gapic::PathTemplate::Segment
+        "\#{#{segment.name}}"
+      else
+        # Should be a String
+        segment
+      end
+    end.join
+  end
+
+  def positional_args? segments
+    arg_segments(segments).any?(&:positional?)
+  end
+
+  def named_arg_patterns? segments
+    arg_segments(segments).any?(&:pattern)
+  end
+end

data/templates/default/helpers/presenters/sample_presenter.rb

@@ -0,0 +1,74 @@
+# 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"
+
+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
+
+  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

data/templates/default/helpers/presenters/service_presenter.rb

@@ -0,0 +1,276 @@
+# 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_relative "gem_presenter"
+require_relative "package_presenter"
+require_relative "resource_presenter"
+require_relative "method_presenter"
+
+class ServicePresenter
+  include FilepathHelper
+  include NamespaceHelper
+
+  def initialize api, service
+    @api = api
+    @service = 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 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 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
+    @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_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 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