gapic-generator 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c8a401f416529802324b86833c5c3a9fcef01afd699439053ce868a7862c5c8
-  data.tar.gz: 6f794cc05eb33a4c201bdcc62dc62524406ae2fb003f0b2d9c536482517a4109
+  metadata.gz: ab653b4ab114926d58b96c5326de2a8ece5ad19d2780cb8ec5886ee83a3cb053
+  data.tar.gz: 733ccb95f513617b9fc653ac8bbc8f02a37fa8be1a8b81c5cec051299d5f7468
 SHA512:
-  metadata.gz: 536731d9a866b0c58540b6eb6f62469eef75f10f82a9fba3c45e0e5a2c5d08b7f5b97b0b385b3e6063e418e0faba687faf45c44cc700ab69da554c9d28a46049
-  data.tar.gz: c1b99ad4ebfae8c4085522924ba4fd11f1a2628b67d64dfc549f22df40aadf5d79ae127bcac73ca5fe2795937f29556b6f656d5b86c66aaef43c78ec644b6772
+  metadata.gz: 5ceea190fdf3424e89df06130809a21f6cc43b61255e1a9fa143413e4ca197a7f52962dcd060693091317226063ae373cb2c6cfdb55bf516ae06c4d9099d43b4
+  data.tar.gz: 7558dd6358c2a19e2e9d471270acb9ce12a94696b67980193e4d6dcafb168f79342a408b68d89408606ff208fec5f5ae5bbad35110f81e9398d2eb5a124c5f43

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History for gapic-generator
 
+### 0.9.0 / 2021-06-29
+
+* Support for configuring the service/method used for the quickstart example
+* Allow generation of libraries with no custom env prefix
+* Add service override setting to the repo metadata
+* Wrapper gem dependencies on pre-GA versioned gems now allow both 0.x and 1.x versions
+* Scoped some String and Hash references to the global scope to avoid name collisions
+* Reformat some config code to avoid rubocop indentation churn
+* Bazel: Replace monolith deps with rules_gapic
+
 ### 0.8.0 / 2021-06-16
 
 * Initial implementation of standalone snippet generation.

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

data/lib/gapic/presenters.rb

@@ -26,6 +26,7 @@ require "gapic/presenters/package_presenter"
 require "gapic/presenters/resource_presenter"
 require "gapic/presenters/sample_presenter"
 require "gapic/presenters/service_presenter"
+require "gapic/presenters/service_config_presenter"
 require "gapic/presenters/service_rest_presenter"
 require "gapic/presenters/snippet_presenter"
 

data/lib/gapic/presenters/gem_presenter.rb

@@ -127,11 +127,7 @@ module Gapic
       end
 
       def env_prefix
-        prefix = gem_config(:env_prefix) || begin
-          segs = name.split("-").reverse
-          segs.find { |seg| seg !~ /^v\d/ } || segs.first || "UNKNOWN"
-        end
-        prefix.upcase
+        gem_config(:env_prefix)&.upcase
       end
 
       def iam_dependency?
@@ -231,6 +227,18 @@ module Gapic
         JSON.pretty_generate first_package_drift_manifest
       end
 
+      ##
+      # The service to use for quick start samples. Normally this is simply the
+      # {#first_non_common_service}, but it can be overridden via a gem config.
+      #
+      # @return [Gapic::Presenters::ServicePresenter]
+      #
+      def quick_start_service
+        preferred_service = gem_config :quick_start_service
+        result = services.find { |svc| svc.name == preferred_service } if preferred_service
+        result || first_non_common_service
+      end
+
       private
 
       def gem_config key

data/lib/gapic/presenters/method_presenter.rb

@@ -232,6 +232,10 @@ module Gapic
         end
       end
 
+      def service_config_presenter
+        ServiceConfigPresenter.new grpc_service_config
+      end
+
       def grpc_method_name
         @method.name
       end

data/lib/gapic/presenters/service_config_presenter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for grpc service config.
+    #
+    class ServiceConfigPresenter
+      def initialize grpc_service_config
+        @grpc_service_config = grpc_service_config
+      end
+
+      attr_reader :grpc_service_config
+
+      def retry_policy_fields
+        elems = []
+        retry_policy = grpc_service_config&.retry_policy
+        if retry_policy&.initial_delay_seconds
+          elems << "initial_delay: #{Gapic::FormattingUtils.format_number retry_policy.initial_delay_seconds}"
+        end
+        if retry_policy&.max_delay_seconds
+          elems << "max_delay: #{Gapic::FormattingUtils.format_number retry_policy.max_delay_seconds}"
+        end
+        if retry_policy&.multiplier
+          elems << "multiplier: #{Gapic::FormattingUtils.format_number retry_policy.multiplier}"
+        end
+        if retry_policy&.status_codes
+          elems << "retry_codes: #{retry_policy.status_codes}"
+        end
+        elems.empty? ? "{}" : "{\n  #{elems.join ', '}\n}"
+      end
+    end
+  end
+end

data/lib/gapic/presenters/service_presenter.rb

@@ -361,6 +361,10 @@ module Gapic
         @api.grpc_service_config.service_level_configs[grpc_full_name]
       end
 
+      def service_config_presenter
+        ServiceConfigPresenter.new grpc_service_config
+      end
+
       ##
       # The short proto name for this service
       #
@@ -405,6 +409,20 @@ module Gapic
         generate_rest_clients? ? "GRPC client" : "client"
       end
 
+      ##
+      # The method to use for quick start samples. Normally this is simply the
+      # first non-client-streaming method defined, but it can be overridden via
+      # a gem config.
+      #
+      # @return [Gapic::Presenters::MethodPresenter]
+      #
+      def quick_start_method
+        gem_config = @api.configuration[:gem]
+        preferred_method = gem_config[:quick_start_method] if gem_config
+        result = methods.find { |meth| meth.name == preferred_method } if preferred_method
+        result || methods.find { |meth| !meth.client_streaming? }
+      end
+
       private
 
       def default_config key

data/templates/default/gem/readme.erb

@@ -16,12 +16,12 @@ $ gem install <%= gem.name %>
 
 ```ruby
 require "<%= gem.entrypoint_require %>"
-<%- service = gem.first_non_common_service -%>
-<%- method = service&.methods.first -%>
+<%- service = gem.quick_start_service -%>
+<%- method = service&.quick_start_method -%>
 <%- if service && method -%>
 
 client = <%= service.create_client_call %>
-request = my_create_request
+request = <%= method.request_type %>.new # (request fields as keyword arguments...)
 response = client.<%= method.name %> request
 <%- end -%>
 ```

data/templates/default/service/client/_client.erb

@@ -104,7 +104,7 @@ class <%= service.client_name %>
                              !@config.endpoint.split(".").first.include?("-")
     credentials ||= Credentials.default scope: @config.scope,
                                         enable_self_signed_jwt: enable_self_signed_jwt
-    if credentials.is_a?(String) || credentials.is_a?(Hash)
+    if credentials.is_a?(::String) || credentials.is_a?(::Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
     <%- end -%>

data/templates/default/service/client/_credentials.erb

@@ -12,10 +12,12 @@ class <%= service.credentials_name %> < ::Google::Auth::Credentials
   <%- end -%>
   ]
   <%- end -%>
+  <%- if service.gem.env_prefix -%>
   self.env_vars = [
     "<%= service.gem.env_prefix %>_CREDENTIALS",
     "<%= service.gem.env_prefix %>_KEYFILE",
     "<%= service.gem.env_prefix %>_CREDENTIALS_JSON",
     "<%= service.gem.env_prefix %>_KEYFILE_JSON"
   ]
+  <%- end -%>
 end

data/templates/default/service/client/_operations.erb

@@ -61,7 +61,7 @@ class <%= service.operations_name %>
     # Create credentials
     credentials = @config.credentials
     credentials ||= Credentials.default scope: @config.scope
-    if credentials.is_a?(String) || credentials.is_a?(Hash)
+    if credentials.is_a?(::String) || credentials.is_a?(::Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
     @quota_project_id = @config.quota_project

data/templates/default/service/client/_self_configure_defaults.erb

@@ -6,7 +6,7 @@
     default_config.timeout = <%= format_number service.grpc_service_config.timeout_seconds %>
   <%- end -%>
   <%- if service.grpc_service_config.retry_policy -%>
-    default_config.retry_policy = <%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: service.grpc_service_config.retry_policy }), 2 %>
+    default_config.retry_policy = <%= indent_tail service.service_config_presenter.retry_policy_fields, 2 %>
   <%- end -%>
 <%- end -%>
 <%- method_service.methods.each do |method| -%>
@@ -16,7 +16,7 @@
       default_config.rpcs.<%= method.name %>.timeout = <%= format_number method.grpc_service_config.timeout_seconds %>
     <%- end -%>
     <%- if method.grpc_service_config.retry_policy -%>
-      default_config.rpcs.<%= method.name %>.retry_policy =<%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: method.grpc_service_config.retry_policy }), 2 %>
+      default_config.rpcs.<%= method.name %>.retry_policy =<%= indent_tail method.service_config_presenter.retry_policy_fields, 2 %>
     <%- end -%>
   <%- end -%>
 <%- end -%>

data/templates/default/service/rest/client/_client.erb

@@ -97,7 +97,7 @@ class <%= service.rest.client_name %>
     credentials = @config.credentials
     <%- unless service.generic_endpoint? -%>
     credentials ||= Credentials.default scope: @config.scope
-    if credentials.is_a?(String) || credentials.is_a?(Hash)
+    if credentials.is_a?(::String) || credentials.is_a?(::Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
     <%- end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -220,6 +220,7 @@ files:
 - lib/gapic/presenters/package_presenter.rb
 - lib/gapic/presenters/resource_presenter.rb
 - lib/gapic/presenters/sample_presenter.rb
+- lib/gapic/presenters/service_config_presenter.rb
 - lib/gapic/presenters/service_presenter.rb
 - lib/gapic/presenters/service_rest_presenter.rb
 - lib/gapic/presenters/snippet_presenter.rb
@@ -285,7 +286,6 @@ files:
 - templates/default/service/client/_resource.erb
 - templates/default/service/client/_self_configure.erb
 - templates/default/service/client/_self_configure_defaults.erb
-- templates/default/service/client/_self_configure_retry_policy.erb
 - templates/default/service/client/method/_def.erb
 - templates/default/service/client/method/def/_options_defaults.erb
 - templates/default/service/client/method/def/_request.erb

data/templates/default/service/client/_self_configure_retry_policy.erb

@@ -1,15 +0,0 @@
-<%- assert_locals retry_policy -%>
-{
-  <%- if retry_policy.initial_delay_seconds -%>
-  initial_delay: <%= format_number retry_policy.initial_delay_seconds %>,
-  <%- end -%>
-  <%- if retry_policy.max_delay_seconds -%>
-  max_delay: <%= format_number retry_policy.max_delay_seconds %>,
-  <%- end -%>
-  <%- if retry_policy.multiplier -%>
-  multiplier: <%= format_number retry_policy.multiplier %>,
-  <%- end-%>
-  <%- if retry_policy.status_codes -%>
-  retry_codes: <%= retry_policy.status_codes %>
-  <%- end -%>
-}