google-cloud-datastore 1.8.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24443175e79fea809e939ff9a0270b29267fc9adaffb9ed0aae19728fd296904
-  data.tar.gz: 04cad098d4bc8d86d4d95ca8aeef0eab46f57491fc4c0b5dd32640587d383604
+  metadata.gz: 5cc84b3b7cf1ffd53fb9014894883cf4a6245a105365c97c5a4665abd2241ff0
+  data.tar.gz: 9b7acbddf571fd3b5c02b926fc676cfa0ed20bcda6eebaf02b7162c819585ae4
 SHA512:
-  metadata.gz: 0423c4729d6962cf87e42641a838554521e22f4390146480d3e296c3e3f2d9a385958113c223b3d080bc4ef5311359c56ce6967011deaf8672d4521261aee24d
-  data.tar.gz: 3fbfeb296dcfd2d59779e2c971bae80e149804242a9962cc877bef8c79580700846f07f21cec5fefd96a6fd722c040632acdbf89d3a2fc629bbf476188d8fadd
+  metadata.gz: cd15c934e7ca1296df239924f55a02b2c105756cdbd60ffb538371bef4ff94176a04969678ed51e9337ad4b94d6d7faeb3e2366ac5c968225b7ddc9d4da1d86b
+  data.tar.gz: 31e397c409100133092611020ca472c671e8be85d1932be97cb3399c4ee576654f8a4018f98c9f6119be3881893d614b622a2243d13298b856ea359a83a58351

data/AUTHENTICATION.md

@@ -76,7 +76,8 @@ The environment variables that google-cloud-datastore checks for project ID are:
 1. `DATASTORE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-datastore checks for credentials are configured on {Google::Cloud::Datastore::V1::Credentials}:
+The environment variables that google-cloud-datastore checks for credentials are configured on
+{Google::Cloud::Datastore::Credentials}:
 
 1. `DATASTORE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `DATASTORE_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 2.2.0 / 2021-03-10
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 2.1.0 / 2020-09-17
+
+#### Features
+
+* quota_project can be set via library configuration ([#7630](https://www.github.com/googleapis/google-cloud-ruby/issues/7630))
+
+### 2.0.0 / 2020-08-06
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-datastore-v1` gem as a dependency.
+The new dependency is a rewritten low-level client, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-datastore-v1`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Datastore::V1` module,
+please review the docs for the new `google-cloud-datastore-v1` gem. In
+particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 1.8.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
+### 1.8.1 / 2020-05-19
+
+#### Bug Fixes
+
+* Adjusted some default timeout and retry settings
+
 ### 1.8.0 / 2020-03-11
 
 #### Features

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-datastore console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-datastore requires Ruby 2.4+. You may choose to
+1. Install Ruby. google-cloud-datastore requires Ruby 2.5+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
@@ -45,7 +45,7 @@ there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-datastore/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Console

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

data/TROUBLESHOOTING.md

@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
 
   - [New issue][gh-ruby]
 
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
 [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+datastore
 
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+datastore%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+[gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+datastore%22
 
-[slack-ruby]: https://gcp-slack.appspot.com/
+[gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new

data/lib/google-cloud-datastore.rb

@@ -42,8 +42,6 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/datastore`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. See Google::Gax::CallSettings. Optional.
     #
     # @return [Google::Cloud::Datastore::Dataset]
     #
@@ -69,10 +67,9 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   datastore = gcloud.datastore scope: platform_scope
     #
-    def datastore scope: nil, timeout: nil, client_config: nil
+    def datastore scope: nil, timeout: nil
       Google::Cloud.datastore @project, @keyfile,
-                              scope: scope, timeout: (timeout || @timeout),
-                              client_config: client_config
+                              scope: scope, timeout: (timeout || @timeout)
     end
 
     ##
@@ -96,8 +93,6 @@ module Google
     #
     #   * `https://www.googleapis.com/auth/datastore`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. See Google::Gax::CallSettings. Optional.
     #
     # @return [Google::Cloud::Datastore::Dataset]
     #
@@ -117,12 +112,11 @@ module Google
     #   datastore.save task
     #
     def self.datastore project_id = nil, credentials = nil, scope: nil,
-                       timeout: nil, client_config: nil
+                       timeout: nil
       require "google/cloud/datastore"
       Google::Cloud::Datastore.new project_id: project_id,
                                    credentials: credentials,
-                                   scope: scope, timeout: timeout,
-                                   client_config: client_config
+                                   scope: scope, timeout: timeout
     end
   end
 end
@@ -141,17 +135,18 @@ Google::Cloud.configure.add_config! :datastore do |config|
   default_emulator = Google::Cloud::Config.deferred do
     ENV["DATASTORE_EMULATOR_HOST"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/datastore"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
-  config.add_field! :credentials, default_creds,
-                    match: [String, Hash, Google::Auth::Credentials],
-                    allow_nil: true
+  config.add_field! :credentials, default_creds, match: [String, Hash, Google::Auth::Credentials], allow_nil: true
   config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :emulator_host, default_emulator,
-                    match: String, allow_nil: true
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
+  config.add_field! :endpoint, "datastore.googleapis.com", match: String
 end

data/lib/google/cloud/datastore.rb

@@ -70,8 +70,6 @@ module Google
       #
       #   * `https://www.googleapis.com/auth/datastore`
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. See Google::Gax::CallSettings. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Datastore emulator host. Optional.
@@ -99,13 +97,17 @@ module Google
       #
       #   datastore.save task
       #
-      def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, emulator_host: nil,
-                   project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   emulator_host: nil,
+                   project: nil,
+                   keyfile: nil
         project_id    ||= (project || default_project_id)
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         endpoint      ||= configure.endpoint
         emulator_host ||= configure.emulator_host
 
@@ -116,8 +118,7 @@ module Google
           return Datastore::Dataset.new(
             Datastore::Service.new(
               project_id, :this_channel_is_insecure,
-              host: emulator_host, timeout: timeout,
-              client_config: client_config
+              host: emulator_host, timeout: timeout
             )
           )
         end
@@ -136,7 +137,7 @@ module Google
         Datastore::Dataset.new(
           Datastore::Service.new(
             project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config
+            host: endpoint, timeout: timeout
           )
         )
       end
@@ -158,8 +159,6 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `emulator_host` - (String) Host name of the emulator. Defaults to
@@ -191,4 +190,6 @@ module Google
       end
     end
   end
+  ## Legacy generated client namespace
+  Datastore = Cloud::Datastore unless const_defined? :Datastore
 end

data/lib/google/cloud/datastore/commit.rb

@@ -136,16 +136,16 @@ module Google
         def mutations
           mutations = []
           mutations += @shared_upserts.map do |entity|
-            Google::Datastore::V1::Mutation.new upsert: entity.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new upsert: entity.to_grpc
           end
           mutations += @shared_inserts.map do |entity|
-            Google::Datastore::V1::Mutation.new insert: entity.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new insert: entity.to_grpc
           end
           mutations += @shared_updates.map do |entity|
-            Google::Datastore::V1::Mutation.new update: entity.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new update: entity.to_grpc
           end
           mutations += @shared_deletes.map do |key|
-            Google::Datastore::V1::Mutation.new delete: key.to_grpc
+            Google::Cloud::Datastore::V1::Mutation.new delete: key.to_grpc
           end
           mutations
         end

data/lib/google/cloud/datastore/convert.rb

@@ -77,7 +77,7 @@ module Google
         end
 
         ##
-        # Gets an object from a Google::Datastore::V1::Value.
+        # Gets an object from a Google::Cloud::Datastore::V1::Value.
         def self.from_value grpc_value
           if grpc_value.value_type == :null_value
             return nil
@@ -110,9 +110,9 @@ module Google
         end
 
         ##
-        # Stores an object into a Google::Datastore::V1::Value.
+        # Stores an object into a Google::Cloud::Datastore::V1::Value.
         def self.to_value value
-          v = Google::Datastore::V1::Value.new
+          v = Google::Cloud::Datastore::V1::Value.new
           if NilClass === value
             v.null_value = :NULL_VALUE
           elsif TrueClass === value
@@ -133,7 +133,7 @@ module Google
           elsif String === value
             v.string_value = value
           elsif Array === value
-            v.array_value = Google::Datastore::V1::ArrayValue.new(
+            v.array_value = Google::Cloud::Datastore::V1::ArrayValue.new(
               values: value.map { |val| to_value val }
             )
           elsif value.respond_to? :to_time

data/lib/google/cloud/datastore/credentials.rb

@@ -14,7 +14,7 @@
 
 
 require "googleauth"
-require "google/cloud/datastore/v1/credentials"
+require "google/cloud/datastore/v1/datastore/credentials"
 
 module Google
   module Cloud
@@ -38,7 +38,7 @@ module Google
       #
       #   datastore.project_id #=> "my-todo-project"
       #
-      class Credentials < Google::Cloud::Datastore::V1::Credentials
+      class Credentials < Google::Cloud::Datastore::V1::Datastore::Credentials
       end
     end
   end

data/lib/google/cloud/datastore/dataset.rb

@@ -535,9 +535,9 @@ module Google
           begin
             yield tx
             tx.commit
-          rescue Google::Cloud::UnavailableError => err
+          rescue Google::Cloud::UnavailableError => e
             # Re-raise if deadline has passed
-            raise err if Time.now - start_time > deadline
+            raise e if Time.now - start_time > deadline
 
             # Sleep with incremental backoff
             sleep backoff *= 1.3
@@ -878,7 +878,7 @@ module Google
 
         def validate_deadline deadline
           return 60 unless deadline.is_a? Numeric
-          return 60 if deadline < 0
+          return 60 if deadline.negative?
           deadline
         end
 

data/lib/google/cloud/datastore/dataset/lookup_results.rb

@@ -167,17 +167,17 @@ module Google
           #     puts "Task #{t.key.id} (#cursor)"
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next
@@ -187,14 +187,14 @@ module Google
           ##
           # @private New Dataset::LookupResults from a
           # Google::Dataset::V1::LookupResponse object.
-          def self.from_grpc lookup_res, service, consistency = nil, tx = nil
+          def self.from_grpc lookup_res, service, consistency = nil, transaction = nil
             entities = to_gcloud_entities lookup_res.found
             deferred = to_gcloud_keys lookup_res.deferred
             missing  = to_gcloud_entities lookup_res.missing
             new(entities).tap do |lr|
               lr.instance_variable_set :@service,     service
               lr.instance_variable_set :@consistency, consistency
-              lr.instance_variable_set :@transaction, tx
+              lr.instance_variable_set :@transaction, transaction
               lr.instance_variable_set :@deferred,    deferred
               lr.instance_variable_set :@missing,     missing
             end

data/lib/google/cloud/datastore/dataset/query_results.rb

@@ -266,17 +266,17 @@ module Google
           #     puts "Task #{t.key.id} (#cursor)"
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next
@@ -335,7 +335,7 @@ module Google
           #     puts "Task #{task.key.id} (#cursor)"
           #   end
           #
-          def all_with_cursor request_limit: nil
+          def all_with_cursor request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all_with_cursor, request_limit: request_limit
@@ -343,10 +343,10 @@ module Google
             results = self
 
             loop do
-              results.zip(results.cursors).each { |r, c| yield r, c }
+              results.zip(results.cursors).each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next

data/lib/google/cloud/datastore/entity.rb

@@ -293,7 +293,7 @@ module Google
         #   task.persisted? #=> true
         #
         def persisted?
-          @key && @key.frozen?
+          @key&.frozen?
         end
 
         ##
@@ -427,10 +427,10 @@ module Google
         end
 
         ##
-        # @private Convert the Entity to a Google::Datastore::V1::Entity
+        # @private Convert the Entity to a Google::Cloud::Datastore::V1::Entity
         # object.
         def to_grpc
-          grpc = Google::Datastore::V1::Entity.new(
+          grpc = Google::Cloud::Datastore::V1::Entity.new(
             properties: @properties.to_grpc
           )
           grpc.key = @key.to_grpc unless @key.nil?
@@ -439,7 +439,7 @@ module Google
         end
 
         ##
-        # @private Create a new Entity from a Google::Datastore::V1::Key
+        # @private Create a new Entity from a Google::Cloud::Datastore::V1::Key
         # object.
         def self.from_grpc grpc
           entity = Entity.new