gapic-generator-cloud 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e19aa05da89d8cd2c3786a6b8df6aabdf3a1e350a759d693f157f7aa97403da5
-  data.tar.gz: 686c3ec9da22e5d3d6de80c53ba6ff7f98cbf32ae92dc60a91f62dee5849b15b
+  metadata.gz: 57149fac08b20d6e334e33b7e27e136430c024953f54bcd906f9a91c49ffe2db
+  data.tar.gz: bfa5c66f6d47bf20a6bbe9f217f2e34cbc6a94f53a5768830045a59d1c8a6d7c
 SHA512:
-  metadata.gz: 5040c06a7e04e7d8a1f020bfe3332495ad1c346966237d14e813442b58416ff332eb955443191328c68b0ee35de907f0587d5b821d6015d86b7ce11dd96747cf
-  data.tar.gz: 36d887e5fd2669fe1220f8a57816b1f06efd3a100ff18c9882458bfd57d364a618d8e76be2b514adf1596af1a6554f416fe38881767b98e8b9d7909bffb5bdd9
+  metadata.gz: bfc7b46a6028c007bf4b75b11c03067f39331c63f046153bbd63a6757427116c8c7859a8e3ea87c9ac211f96a4c694175c2379fb7b3a4b045fcf37e46d0e3034
+  data.tar.gz: 0ea77a6b3a09412112b5e183d578651b3176bb21820961b0e5611ef13858ca9b0f6ba4b03f438ff2dec523700a5c516494de380fda6c1df522435b8baf497eb5

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Release History for gapic-generator-cloud
 
+### 0.11.0 / 2022-03-01
+
+* Includes changes from gapic-generator 0.11.0
+
+### 0.10.6 / 2022-02-02
+
+* Includes changes from gapic-generator 0.10.6
+* Add api_shortname and release_level to generated repo-metadata.json file
+* Point cloud client reference documentation URLs to cloud.google.com
+
+### 0.10.5 / 2022-01-20
+
+* Includes changes from gapic-generator 0.10.5
+* Interim support for wrappers of REST clients.
+
+### 0.10.4 / 2022-01-07
+
+* Includes changes from gapic-generator 0.10.4
+* Removes broken image links and fixes outdated content in the auth template.
+
+### 0.10.3 / 2021-11-04
+
+* Includes changes from gapic-generator 0.10.3
+
+### 0.10.2 / 2021-11-01
+
+* Includes changes from gapic-generator 0.10.2
+
 ### 0.10.1 / 2021-08-27
 
 * Includes changes from gapic-generator 0.10.1

data/lib/gapic/generator/cloud/version.rb

@@ -18,7 +18,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.10.1"
+      VERSION = "0.11.0"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -59,7 +59,6 @@ module Gapic
         # Additional Gem level files
         cloud_files = []
         cloud_files << g("gem/repo-metadata.erb", ".repo-metadata.json", gem: gem)
-        cloud_files << g("gem/yardopts-cloudrad.erb", ".yardopts-cloudrad", gem: gem)
         unless gem.services.empty? || gem.generic_endpoint?
           cloud_files << g("gem/authentication.erb", "AUTHENTICATION.md", gem: gem)
         end
@@ -87,7 +86,6 @@ module Gapic
         files << g("gem/repo-metadata.erb",             ".repo-metadata.json",                           gem: gem)
         files << g("wrapper_gem/rubocop.erb",           ".rubocop.yml",                                  gem: gem)
         files << g("wrapper_gem/yardopts.erb",          ".yardopts",                                     gem: gem)
-        files << g("wrapper_gem/yardopts-cloudrad.erb", ".yardopts-cloudrad",                            gem: gem)
         files << g("gem/authentication.erb",            "AUTHENTICATION.md",                             gem: gem) unless gem.generic_endpoint?
         files << g("gem/changelog.erb",                 "CHANGELOG.md",                                  gem: gem)
         files << g("wrapper_gem/gemfile.erb",           "Gemfile",                                       gem: gem)

data/lib/gapic/generators/cloud_generator_parameters.rb

@@ -48,6 +48,7 @@ module Gapic
         "ruby-cloud-quick-start-method"    => ":gem.:quick_start_method",
         "ruby-cloud-default-service-host"  => ":defaults.:service.:default_host",
         "ruby-cloud-grpc-service-config"   => "grpc_service_config",
+        "ruby-cloud-service-yaml"          => ":service_yaml",
         "ruby-cloud-wrapper-gem-override"  => ":overrides.:wrapper_gem_name"
       }.freeze
 

data/lib/gapic/presenters/cloud_gem_presenter.rb

@@ -98,6 +98,12 @@ module Gapic
         result["ruby-cloud-service-override"] = service_overrides unless service_overrides.empty?
         result
       end
+
+      ##
+      # Overrides the reference doc URL to point to the cloud-rad page
+      def library_documentation_url
+        gem_config(:library_documentation_url) || "https://cloud.google.com/ruby/docs/reference/#{name}/latest"
+      end
     end
 
     def self.cloud_gem_presenter api

data/lib/gapic/presenters/wrapper_service_presenter.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/presenters"
+require "gapic/presenters/wrapper_service_rest_presenter"
 require "gapic/ruby_info"
 
 module Gapic
@@ -23,6 +24,11 @@ module Gapic
     # A presenter for wrapper services.
     #
     class WrapperServicePresenter < ServicePresenter
+      def initialize *args, **kwargs
+        super(*args, **kwargs)
+        @rest = WrapperServiceRestPresenter.new self, @api
+      end
+
       def factory_method_name
         @factory_method_name ||= begin
           method_name = ActiveSupport::Inflector.underscore name
@@ -33,6 +39,22 @@ module Gapic
         end
       end
 
+      ##
+      # Returns this service presenter if there is a grpc client. Otherwise,
+      # returns the corresponding rest service presenter if there isn't a grpc
+      # client but there is a rest client. Otherwise, returns nil if there is
+      # neither client.
+      #
+      # @return [WrapperServicePresenter,WrapperServiceRestPresenter,nil]
+      #
+      def usable_service_presenter
+        if @api.generate_grpc_clients?
+          self
+        elsif @api.generate_rest_clients? && methods_rest_bindings?
+          rest
+        end
+      end
+
       def create_client_call
         "#{gem.namespace}.#{factory_method_name}"
       end

data/lib/gapic/presenters/wrapper_service_rest_presenter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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/presenters"
+require "gapic/ruby_info"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for wrapper services.
+    #
+    class WrapperServiceRestPresenter < ServiceRestPresenter
+      def factory_method_name
+        @factory_method_name ||= begin
+          method_name = ActiveSupport::Inflector.underscore main_service.name
+          suffix = main_service.gem.factory_method_suffix
+          method_name = "#{method_name}#{suffix}" unless method_name.end_with? suffix
+          method_name = "#{method_name}_client" if Gapic::RubyInfo.excluded_method_names.include? method_name
+          method_name
+        end
+      end
+
+      def create_client_call
+        "#{main_service.gem.namespace}.#{factory_method_name}"
+      end
+
+      def configure_client_call
+        "#{main_service.gem.namespace}.configure"
+      end
+
+      def credentials_class_xref
+        "`#{main_service.credentials_name_full}`"
+      end
+    end
+  end
+end

data/templates/cloud/gem/authentication.erb

@@ -125,15 +125,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -144,31 +135,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/templates/cloud/gem/rakefile.erb

@@ -149,11 +149,6 @@ task :doctest do
   puts "The <%= gem.name %> gem does not have doctest tests."
 end
 
-task :cloudrad do
-  ENV["CLOUDRAD_GEM_NAME"] = "<%= gem.name %>"
-  sh "bundle exec yard doc --fail-on-warning --yardopts .yardopts-cloudrad"
-end
-
 desc "Run the CI build"
 task :ci do
   header "BUILDING <%= gem.name %>"

data/templates/cloud/gem/repo-metadata.erb

@@ -2,6 +2,9 @@
 {
 <%- if gem.api_id -%>
     "api_id": "<%= gem.api_id %>",
+<%- end -%>
+<%- if gem.api_shortname -%>
+    "api_shortname": "<%= gem.api_shortname %>",
 <%- end -%>
     "client_documentation": "<%= gem.library_documentation_url %>",
     "distribution_name": "<%= gem.name %>",
@@ -16,6 +19,7 @@
 <%- if gem.product_documentation_url -%>
     "product_documentation": "<%= gem.product_documentation_url %>",
 <%- end -%>
+    "release_level": "unknown",
     "repo": "googleapis/google-cloud-ruby",
     "requires_billing": <%= !gem.free_tier? %>,
 <%- gem.generator_args_for_metadata.each do |key, val| -%>

data/templates/cloud/gem/yardopts.erb

@@ -1,6 +1,6 @@
 <%- assert_locals gem -%>
 --no-private
---title=<%= gem.title %> API
+--title="<%= gem.title %> API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/templates/cloud/wrapper_gem/_main.erb

@@ -19,20 +19,25 @@ require "google/cloud/config"
   config.add_field! :scope,         nil, match: [::Array, ::String]
   config.add_field! :lib_name,      nil, match: ::String
   config.add_field! :lib_version,   nil, match: ::String
+<%- unless gem.generate_rest_clients? -%>
   config.add_field! :interceptors,  nil, match: ::Array
+<%- end -%>
   config.add_field! :timeout,       nil, match: ::Numeric
   config.add_field! :metadata,      nil, match: ::Hash
+<%- unless gem.generate_rest_clients? -%>
   config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
   config.add_field! :quota_project, nil, match: ::String
+<%- end -%>
 end
 <%- end -%>
 <% end %>
 <%- gem.services.each do |service| -%>
+<%- client_class_name_suffix = service.generate_rest_clients? ? "Rest::#{service.client_name}" : service.client_name -%>
 ##
 # Create a new client object for <%= service.module_name %>.
 #
 # By default, this returns an instance of
-# <%= gem.docs_link version: gem.default_version, class_name: "#{service.module_name}::Client" %>
+# <%= gem.docs_link version: gem.default_version, class_name: "#{service.module_name}::#{client_class_name_suffix}" %>
 # for version <%= gem.default_version.capitalize %> of the API.
 # However, you can specify specify a different API version by passing it in the
 # `version` parameter. If the <%= service.module_name %> service is
@@ -47,7 +52,7 @@ end
 <%- end -%>
 # @param version [::String, ::Symbol] The API version to connect to. Optional.
 #   Defaults to `:<%= gem.default_version %>`.
-# @return [<%= service.module_name %>::Client] A client object for the specified version.
+# @return [<%= service.module_name %>::<%= client_class_name_suffix %>] A client object for the specified version.
 #
 def self.<%= service.factory_method_name %> version: :<%= gem.default_version %>, &block
   require "<%= gem.namespace_require %>/#{version.to_s.downcase}"
@@ -57,7 +62,7 @@ def self.<%= service.factory_method_name %> version: :<%= gem.default_version %>
                   .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                   .first
   package_module = <%= gem.namespace %>.const_get package_name
-  package_module.const_get(:<%= service.module_name %>).const_get(:Client).new(&block)
+  package_module.const_get(:<%= service.module_name %>)<% if service.generate_rest_clients? %>.const_get(:Rest)<% end %>.const_get(:Client).new(&block)
 end
 
 <%- end -%>
@@ -74,12 +79,15 @@ end
 #   The library name as recorded in instrumentation and logging.
 # * `lib_version` (*type:* `String`) -
 #   The library version as recorded in instrumentation and logging.
+<%- unless gem.generate_rest_clients? -%>
 # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
 #   An array of interceptors that are run before calls are executed.
+<%- end -%>
 # * `timeout` (*type:* `Numeric`) -
 #   Default timeout in seconds.
 # * `metadata` (*type:* `Hash{Symbol=>String}`) -
-#   Additional gRPC headers to be sent with the call.
+#   Additional <% if gem.generate_rest_clients? %>REST<% else %>gRPC<% end %> headers to be sent with the call.
+<%- unless gem.generate_rest_clients? -%>
 # * `retry_policy` (*type:* `Hash`) -
 #   The retry policy. The value is a hash with the following keys:
 #     * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
@@ -87,6 +95,7 @@ end
 #     * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
 #     * `:retry_codes` (*type:* `Array<String>`) -
 #       The error codes that should trigger a retry.
+<%- end -%>
 #
 # @return [::Google::Cloud::Config] The default configuration used by this library
 #

data/templates/cloud/wrapper_gem/client_test.erb

@@ -8,13 +8,20 @@ require "gapic/grpc"
 
 class <%= gem.namespace %>::ClientConstructionMinitest < Minitest::Test
 <%- gem.services.each do |service| -%>
+  <%- client_class_name_suffix = service.generate_rest_clients? ? "Rest::#{service.client_name}" : service.client_name -%>
   def test_<%= service.factory_method_name %>
     Gapic::ServiceStub.stub :new, :stub do
+      <%- if service.generate_rest_clients? -%>
+      client = <%= gem.namespace %>.<%= service.factory_method_name %> do |config|
+        config.credentials = :dummy_credentials
+      end
+      <%- else -%>
       grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
       client = <%= gem.namespace %>.<%= service.factory_method_name %> do |config|
         config.credentials = grpc_channel
       end
-      assert_kind_of <%= gem.namespaced_class "#{service.module_name}::Client", version: gem.default_version %>, client
+      <%- end -%>
+      assert_kind_of <%= gem.namespaced_class "#{service.module_name}::#{client_class_name_suffix}", version: gem.default_version %>, client
     end
   end
 

data/templates/cloud/wrapper_gem/rakefile.erb

@@ -148,11 +148,6 @@ task :doctest do
   puts "The <%= gem.name %> gem does not have doctest tests."
 end
 
-task :cloudrad do
-  ENV["CLOUDRAD_GEM_NAME"] = "<%= gem.name %>"
-  sh "bundle exec yard doc --fail-on-warning --yardopts .yardopts-cloudrad"
-end
-
 desc "Run the CI build"
 task :ci do
   header "BUILDING <%= gem.name %>"

data/templates/cloud/wrapper_gem/readme.erb

@@ -60,6 +60,7 @@ versions of this library will likely require updates to use this version.
 See the {file:MIGRATING.md MIGRATING.md} document for more information.
 
 <%- end -%>
+<%- unless gem.generate_rest_clients? -%>
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
@@ -86,6 +87,7 @@ module GRPC
 end
 ```
 
+<%- end -%>
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.5+.

data/templates/cloud/wrapper_gem/yardopts.erb

@@ -1,6 +1,6 @@
 <%- assert_locals gem -%>
 --no-private
---title=<%= gem.title %> API
+--title="<%= gem.title %> API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -74,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.41.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.41.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +177,7 @@ files:
 - lib/gapic/presenters/cloud_gem_presenter.rb
 - lib/gapic/presenters/wrapper_gem_presenter.rb
 - lib/gapic/presenters/wrapper_service_presenter.rb
+- lib/gapic/presenters/wrapper_service_rest_presenter.rb
 - templates/cloud/gem/authentication.erb
 - templates/cloud/gem/gitignore.erb
 - templates/cloud/gem/license.erb
@@ -170,7 +185,6 @@ files:
 - templates/cloud/gem/readme.erb
 - templates/cloud/gem/repo-metadata.erb
 - templates/cloud/gem/rubocop.erb
-- templates/cloud/gem/yardopts-cloudrad.erb
 - templates/cloud/gem/yardopts.erb
 - templates/cloud/service/client/_credentials.erb
 - templates/cloud/service/client/_requires.erb
@@ -190,7 +204,6 @@ files:
 - templates/cloud/wrapper_gem/readme.erb
 - templates/cloud/wrapper_gem/rubocop.erb
 - templates/cloud/wrapper_gem/version_test.erb
-- templates/cloud/wrapper_gem/yardopts-cloudrad.erb
 - templates/cloud/wrapper_gem/yardopts.erb
 homepage: https://github.com/googleapis/gapic-generator-ruby
 licenses:

data/templates/cloud/gem/yardopts-cloudrad.erb

@@ -1,15 +0,0 @@
-<%- assert_locals gem -%>
---no-private
---title=<%= gem.title %> API
---exclude _pb\.rb$
---format yaml
---template-path ../template
-
-./lib/**/*.rb
-./proto_docs/**/*.rb
--
-README.md
-LICENSE.md
-<%- unless gem.generic_endpoint? -%>
-AUTHENTICATION.md
-<%- end -%>

data/templates/cloud/wrapper_gem/yardopts-cloudrad.erb

@@ -1,17 +0,0 @@
-<%- assert_locals gem -%>
---no-private
---title=<%= gem.title %> API
---exclude _pb\.rb$
---format yaml
---template-path ../template
-
-./lib/**/*.rb
--
-README.md
-<%- unless gem.generic_endpoint? -%>
-AUTHENTICATION.md
-<%- end -%>
-<%- if gem.migration? -%>
-MIGRATING.md
-<%- end -%>
-LICENSE.md