google-cloud-datastore 1.8.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 905f1055fbaea77d81cb9152e3eebb63b3777ae5193835a3e44340d7bb61ff40
-  data.tar.gz: bba3960ee3e69c7979a8e6330a132e640ac36f10835b5d6051ea8e979841ac14
+  metadata.gz: 02bfd91dd941f3ae7462fb7a4298568acce9b3b4b2f4e157ae7ff80e6b312b9d
+  data.tar.gz: 968e1bef52b2102f7f946bc19543882aa71d192dff44d43ac530c1d2a90a9a8f
 SHA512:
-  metadata.gz: 1d454255b9931772a99d01c5b7cd08fee32a6e072dab9165a1d9260cf68cb5975fe14c5e12170fe96e9d5c9a457ff5eab8f850313537eda57186fc6b4b1387ed
-  data.tar.gz: 7463bfc195adba4136e61ba7157684515351f7a42c92c41c2266c60c6251a73a5f019898b2c7b6b359d84cbdac05ed39df7aa000fbae8a3d3b584b6e998efdf4
+  metadata.gz: 901c1e1ea9f306588e06a58e9f1a4abe549173b790d17f175a7b4b82eee5080a4d9202c4f426c141dfec24479d3cc8da83175bbba7ac4430b3ff7c36fd466494
+  data.tar.gz: 128ea0ee6c5cecddbcd0555cdb648b85dcb001d419ad53775283d483b16a584ae91c46771271ec6d5fbdd3a8d99717c4eb70336e317efd1d3405758fafe07381

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
@@ -95,7 +96,8 @@ client = Google::Cloud::Datastore.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/datastore"

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Release History
 
+### 2.2.1 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
+### 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

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
@@ -119,7 +119,7 @@ If you alter an example's title, you may encounter breaking tests.
 ### Datastore Acceptance Tests
 
 The Datastore acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
 the Datastore API. Occasionally, some API features may not yet be generally
 available, making it difficult for some contributors to successfully run the
 entire acceptance test suite. However, please ensure that you do successfully

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/OVERVIEW.md

@@ -490,5 +490,5 @@ datastore = Google::Cloud::Datastore.new timeout: 120
 ## Additional information
 
 Google Cloud Datastore can be configured to use an emulator or to enable gRPC's
-logging. To learn more, see the {file:EMULATOR.md Emulator guide} and
+logging. To learn more, see the {file:EMULATOR.md Emulator guide}} and
 {file:LOGGING.md Logging guide}.

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