google-cloud-datastore-v1 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1c966aabe007c9cd1e75c884b34c4e72cd634e01ba343a2a9f828d8e68711f
-  data.tar.gz: dc84800a7f30ac93f6c0d6c837bc6a5db5519f453c04f03252ab920f5fad7f52
+  metadata.gz: fcf15ebfb3845ed4a15c37220b0d78d05d444a73dc4a4d061def433a8832c6c2
+  data.tar.gz: 42d6cc2519e57d1f2ec1063c9ceb45020c3f9d86353eb66bc93dceadfc223090
 SHA512:
-  metadata.gz: 816373e82d7a1a11bc1764adf3d8f061c42e8f020f2a1bbdc8983e83f246212f9efb4b16d6cb3e083661d4fbb06a4b7ec2355dd59931b281aa8e0f8afffafe67
-  data.tar.gz: a51afb859af21c4bb3cd59e0db421e242af7ac90e09b713bd77a43b509531e8bf27ff7f1485b1c05d1a3c22054136b73c541d9b40ac58adcb1fc0e042e7c41e2
+  metadata.gz: 517bc59cd28aea9ddfcfe0fbf8d05e2bdad7e9eaaab89222759b182fcd322ce4de3cc492f9ffe386b9482356c3fd2ad163bb0e3c5dabb869802f61ea275c84ea
+  data.tar.gz: 0dbc7e078491d51232e0b5a0bd3f3e41849cb428ded2b40fef67338c7153180637f64dc35483080f90664debda5da5b82e0f6f79c7b78f7b333e23126fbb35f6

data/README.md

@@ -6,6 +6,12 @@ Firestore in Datastore mode is a NoSQL document database built for automatic sca
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Firestore in Datastore mode V1 API. Most users should consider using
+the main client gem,
+[google-cloud-datastore](https://rubygems.org/gems/google-cloud-datastore).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-datastore`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-datastore-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-datastore`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-datastore-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/cloud/datastore/v1/datastore/client.rb

@@ -161,7 +161,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
+              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                       @config.endpoint == Client.configure.endpoint &&
+                                       !@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)
                 credentials = Credentials.new credentials, scope: @config.scope
               end

data/lib/google/cloud/datastore/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Datastore
       module V1
-        VERSION = "0.1.3"
+        VERSION = "0.2.0"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

data/proto_docs/google/type/latlng.rb

@@ -19,8 +19,8 @@
 
 module Google
   module Type
-    # An object representing a latitude/longitude pair. This is expressed as a pair
-    # of doubles representing degrees latitude and degrees longitude. Unless
+    # An object that represents a latitude/longitude pair. This is expressed as a
+    # pair of doubles to represent degrees latitude and degrees longitude. Unless
     # specified otherwise, this must conform to the
     # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
     # standard</a>. Values must be within normalized ranges.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -151,7 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Firestore in Datastore mode is a NoSQL document database built for automatic
-  scaling, high performance, and ease of application development.
+  scaling, high performance, and ease of application development. Note that google-cloud-datastore-v1
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-datastore instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []