google-cloud-datastore 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5158282d2e12b211e22031224f6f4e18e48e621f824cf21411cf7d4283f3150
-  data.tar.gz: 88de52c6fab28a2e66ad66dc96867c19b08a665da4eb61d478538472ea83ff27
+  metadata.gz: 6677adc0fe54bae8453d609401a902aa2afc5e1231b5ee57a3b75c1d86cdda7e
+  data.tar.gz: f8092af4287def66a0ff425150039e5e9a2dae3e38a2f1adcff037700f01c4c7
 SHA512:
-  metadata.gz: 38d06cae20a6f5ed9125af1aa2a2314d18290608fe0dbf810c3cdea855ca615fb1de64ccb05e04c16a5fc63acd3786fc4fc24c25d8cba5238c38137785662fda
-  data.tar.gz: 411b854b3f2f1f05d274da447b3779b79b19ba2831db349d52bf139bbdda1cc72750c530764ba586da9ae0ebe4b51ae0a040853494d3b327942a6e719a11e0dc
+  metadata.gz: 9690a8f334e5b29a2d18e89420f0adb787b0b5a2b3f5b2c36e8bb7fb4087b566848ed2cb8fff800fe932e60b8225702fe469f6b99e8e1945614a7fbd175705c8
+  data.tar.gz: 77b81d3cab09c0bfe41b2b644f8b7932835a6a0731c90d6f22127a99952703a0ab11b899e1e26ec26a6118ed15d9d8e42d33e2c7f5afef14b33e06927a9d973d

data/.yardopts

@@ -1,7 +1,8 @@
 --no-private
 --title=Google Cloud Datastore
---exclude lib/google/datastore/v1
+--exclude _pb\.rb$
 --markup markdown
+--markup-provider redcarpet
 
 ./lib/**/*.rb
 -

data/README.md

@@ -47,9 +47,38 @@ query = datastore.query("Task").
 tasks = datastore.run query
 ```
 
+## 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. 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 shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.0+.
+This library is supported on Ruby 2.3+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. Currently, this means Ruby 2.3
+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.
 
 ## Versioning
 

data/lib/google/cloud/datastore.rb

@@ -61,6 +61,39 @@ module Google
     # [Google Cloud Datastore Concepts Overview
     # ](https://cloud.google.com/datastore/docs/concepts/overview).
     #
+    # ## 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. 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 shown below, or a
+    # [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+    # that will write logs to [Stackdriver
+    # Logging](https://cloud.google.com/logging/). See
+    # [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+    # and the gRPC
+    # [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
+    # for additional information.
+    #
+    # Configuring a Ruby stdlib logger:
+    #
+    # ```ruby
+    # require "logger"
+    #
+    # module MyLogger
+    #   LOGGER = Logger.new $stderr, level: Logger::WARN
+    #   def logger
+    #     LOGGER
+    #   end
+    # end
+    #
+    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+    # module GRPC
+    #   extend MyLogger
+    # end
+    # ```
+    #
     # ## Retrieving records
     #
     # Records, called "entities" in Datastore, are retrieved by using a key.

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

@@ -14,6 +14,7 @@
 
 
 require "googleauth"
+require "google/cloud/datastore/v1/credentials"
 
 module Google
   module Cloud
@@ -37,20 +38,7 @@ module Google
       #
       #   datastore.project_id #=> "my-todo-project"
       #
-      class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/datastore"].freeze
-        PATH_ENV_VARS = %w[DATASTORE_CREDENTIALS
-                           DATASTORE_KEYFILE
-                           GOOGLE_CLOUD_CREDENTIALS
-                           GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE].freeze
-        JSON_ENV_VARS = %w[DATASTORE_CREDENTIALS_JSON
-                           DATASTORE_KEYFILE_JSON
-                           GOOGLE_CLOUD_CREDENTIALS_JSON
-                           GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON].freeze
-        DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"].freeze
+      class Credentials < Google::Cloud::Datastore::V1::Credentials
       end
     end
   end

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

@@ -0,0 +1,38 @@
+# Copyright 2018 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 "googleauth"
+
+module Google
+  module Cloud
+    module Datastore
+      module V1
+        class Credentials < Google::Auth::Credentials
+          SCOPE = ["https://www.googleapis.com/auth/datastore"].freeze
+          PATH_ENV_VARS = %w(DATASTORE_CREDENTIALS
+                             DATASTORE_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(DATASTORE_CREDENTIALS_JSON
+                             DATASTORE_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,6 @@
 # and updates to that file get reflected here through a refresh process.
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
-#
-# The only allowed edits are to method and file documentation. A 3-way
-# merge preserves those additions if the generated source changes.
 
 require "json"
 require "pathname"
@@ -28,7 +25,7 @@ require "pathname"
 require "google/gax"
 
 require "google/datastore/v1/datastore_pb"
-require "google/cloud/datastore/credentials"
+require "google/cloud/datastore/v1/credentials"
 
 module Google
   module Cloud
@@ -52,6 +49,9 @@ module Google
           # The default port of the service.
           DEFAULT_SERVICE_PORT = 443
 
+          # The default set of gRPC interceptors.
+          GRPC_INTERCEPTORS = []
+
           DEFAULT_TIMEOUT = 30
 
           # The scopes needed to make gRPC calls to all of the methods defined in
@@ -61,6 +61,7 @@ module Google
             "https://www.googleapis.com/auth/datastore"
           ].freeze
 
+
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
           #   be many types.
@@ -85,16 +86,18 @@ module Google
           #   or the specified config is missing data points.
           # @param timeout [Numeric]
           #   The default timeout, in seconds, for calls made through this client.
+          # @param metadata [Hash]
+          #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+          # @param exception_transformer [Proc]
+          #   An optional proc that intercepts any exceptions raised during an API call to inject
+          #   custom error handling.
           def initialize \
-              service_path: SERVICE_ADDRESS,
-              port: DEFAULT_SERVICE_PORT,
-              channel: nil,
-              chan_creds: nil,
-              updater_proc: nil,
               credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -103,21 +106,10 @@ module Google
             require "google/gax/grpc"
             require "google/datastore/v1/datastore_services_pb"
 
-            if channel || chan_creds || updater_proc
-              warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
-                "on 2017/09/08"
-              credentials ||= channel
-              credentials ||= chan_creds
-              credentials ||= updater_proc
-            end
-            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
-              warn "`service_path` and `port` parameters are deprecated and will be removed"
-            end
-
-            credentials ||= Google::Cloud::Datastore::Credentials.default
+            credentials ||= Google::Cloud::Datastore::V1::Credentials.default
 
             if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::Datastore::Credentials.new(credentials).updater_proc
+              updater_proc = Google::Cloud::Datastore::V1::Credentials.new(credentials).updater_proc
             end
             if credentials.is_a?(GRPC::Core::Channel)
               channel = credentials
@@ -132,13 +124,16 @@ module Google
               updater_proc = credentials.updater_proc
             end
 
+            package_version = Gem.loaded_specs['google-cloud-datastore'].version.version
+
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name
-            google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
+            google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
             google_api_client << " grpc/#{GRPC::VERSION}"
             google_api_client.freeze
 
             headers = { :"x-goog-api-client" => google_api_client }
+            headers.merge!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "datastore_client_config.json"
             )
@@ -150,9 +145,14 @@ module Google
                 Google::Gax::Grpc::STATUS_CODE_NAMES,
                 timeout,
                 errors: Google::Gax::Grpc::API_ERRORS,
-                kwargs: headers
+                metadata: headers
               )
             end
+
+            # Allow overriding the service path/port in subclasses.
+            service_path = self.class::SERVICE_ADDRESS
+            port = self.class::DEFAULT_SERVICE_PORT
+            interceptors = self.class::GRPC_INTERCEPTORS
             @datastore_stub = Google::Gax::Grpc.create_stub(
               service_path,
               port,
@@ -160,36 +160,44 @@ module Google
               channel: channel,
               updater_proc: updater_proc,
               scopes: scopes,
+              interceptors: interceptors,
               &Google::Datastore::V1::Datastore::Stub.method(:new)
             )
 
             @lookup = Google::Gax.create_api_call(
               @datastore_stub.method(:lookup),
-              defaults["lookup"]
+              defaults["lookup"],
+              exception_transformer: exception_transformer
             )
             @run_query = Google::Gax.create_api_call(
               @datastore_stub.method(:run_query),
-              defaults["run_query"]
+              defaults["run_query"],
+              exception_transformer: exception_transformer
             )
             @begin_transaction = Google::Gax.create_api_call(
               @datastore_stub.method(:begin_transaction),
-              defaults["begin_transaction"]
+              defaults["begin_transaction"],
+              exception_transformer: exception_transformer
             )
             @commit = Google::Gax.create_api_call(
               @datastore_stub.method(:commit),
-              defaults["commit"]
+              defaults["commit"],
+              exception_transformer: exception_transformer
             )
             @rollback = Google::Gax.create_api_call(
               @datastore_stub.method(:rollback),
-              defaults["rollback"]
+              defaults["rollback"],
+              exception_transformer: exception_transformer
             )
             @allocate_ids = Google::Gax.create_api_call(
               @datastore_stub.method(:allocate_ids),
-              defaults["allocate_ids"]
+              defaults["allocate_ids"],
+              exception_transformer: exception_transformer
             )
             @reserve_ids = Google::Gax.create_api_call(
               @datastore_stub.method(:reserve_ids),
-              defaults["reserve_ids"]
+              defaults["reserve_ids"],
+              exception_transformer: exception_transformer
             )
           end
 
@@ -210,13 +218,20 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::LookupResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::LookupResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
+          #
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
+          #
+          #   # TODO: Initialize +keys+:
           #   keys = []
           #   response = datastore_client.lookup(project_id, keys)
 
@@ -224,14 +239,15 @@ module Google
               project_id,
               keys,
               read_options: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               keys: keys,
               read_options: read_options
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::LookupRequest)
-            @lookup.call(req, options)
+            @lookup.call(req, options, &block)
           end
 
           # Queries for entities.
@@ -260,13 +276,20 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::RunQueryResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::RunQueryResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
+          #
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
+          #
+          #   # TODO: Initialize +partition_id+:
           #   partition_id = {}
           #   response = datastore_client.run_query(project_id, partition_id)
 
@@ -276,7 +299,8 @@ module Google
               read_options: nil,
               query: nil,
               gql_query: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               partition_id: partition_id,
@@ -285,7 +309,7 @@ module Google
               gql_query: gql_query
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::RunQueryRequest)
-            @run_query.call(req, options)
+            @run_query.call(req, options, &block)
           end
 
           # Begins a new transaction.
@@ -299,25 +323,31 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::BeginTransactionResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::BeginTransactionResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
+          #
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
           #   response = datastore_client.begin_transaction(project_id)
 
           def begin_transaction \
               project_id,
               transaction_options: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               transaction_options: transaction_options
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::BeginTransactionRequest)
-            @begin_transaction.call(req, options)
+            @begin_transaction.call(req, options, &block)
           end
 
           # Commits a transaction, optionally creating, deleting or modifying some
@@ -350,14 +380,23 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::CommitResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::CommitResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
+          #
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
+          #
+          #   # TODO: Initialize +mode+:
           #   mode = :MODE_UNSPECIFIED
+          #
+          #   # TODO: Initialize +mutations+:
           #   mutations = []
           #   response = datastore_client.commit(project_id, mode, mutations)
 
@@ -366,7 +405,8 @@ module Google
               mode,
               mutations,
               transaction: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               mode: mode,
@@ -374,7 +414,7 @@ module Google
               transaction: transaction
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::CommitRequest)
-            @commit.call(req, options)
+            @commit.call(req, options, &block)
           end
 
           # Rolls back a transaction.
@@ -387,26 +427,34 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::RollbackResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::RollbackResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
+          #
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
+          #
+          #   # TODO: Initialize +transaction+:
           #   transaction = ''
           #   response = datastore_client.rollback(project_id, transaction)
 
           def rollback \
               project_id,
               transaction,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               transaction: transaction
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::RollbackRequest)
-            @rollback.call(req, options)
+            @rollback.call(req, options, &block)
           end
 
           # Allocates IDs for the given keys, which is useful for referencing an entity
@@ -422,26 +470,34 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::AllocateIdsResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::AllocateIdsResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
+          #
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
+          #
+          #   # TODO: Initialize +keys+:
           #   keys = []
           #   response = datastore_client.allocate_ids(project_id, keys)
 
           def allocate_ids \
               project_id,
               keys,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               keys: keys
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::AllocateIdsRequest)
-            @allocate_ids.call(req, options)
+            @allocate_ids.call(req, options, &block)
           end
 
           # Prevents the supplied keys' IDs from being auto-allocated by Cloud
@@ -459,13 +515,20 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Datastore::V1::ReserveIdsResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Datastore::V1::ReserveIdsResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/datastore/v1"
+          #   require "google/cloud/datastore"
           #
-          #   datastore_client = Google::Cloud::Datastore::V1.new
+          #   datastore_client = Google::Cloud::Datastore.new(version: :v1)
+          #
+          #   # TODO: Initialize +project_id+:
           #   project_id = ''
+          #
+          #   # TODO: Initialize +keys+:
           #   keys = []
           #   response = datastore_client.reserve_ids(project_id, keys)
 
@@ -473,14 +536,15 @@ module Google
               project_id,
               keys,
               database_id: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               project_id: project_id,
               keys: keys,
               database_id: database_id
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Datastore::V1::ReserveIdsRequest)
-            @reserve_ids.call(req, options)
+            @reserve_ids.call(req, options, &block)
           end
         end
       end

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,17 +14,6 @@
 
 module Google
   module Datastore
-    ##
-    # # Google Cloud Datastore API Contents
-    #
-    # | Class | Description |
-    # | ----- | ----------- |
-    # | [DatastoreClient][] | Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. |
-    # | [Data Types][] | Data types for Google::Cloud::Datastore::V1 |
-    #
-    # [DatastoreClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-datastore/latest/google/datastore/v1/datastoreclient
-    # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-datastore/latest/google/datastore/v1/datatypes
-    #
     module V1
       # The request for {Google::Datastore::V1::Datastore::Lookup Datastore::Lookup}.
       # @!attribute [rw] project_id

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/datastore/v1/doc/google/protobuf/wrappers.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Datastore
-      VERSION = "1.4.0".freeze
+      VERSION = "1.4.1".freeze
     end
   end
 end

data/lib/google/datastore/v1/datastore_services_pb.rb

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/datastore/v1/datastore.proto for package 'google.datastore.v1'
 # Original file comments:
-# Copyright 2017 Google Inc.
+# Copyright 2018 Google Inc.
 #
 # 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
+#     http://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,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -209,13 +223,13 @@ files:
 - lib/google/cloud/datastore/service.rb
 - lib/google/cloud/datastore/transaction.rb
 - lib/google/cloud/datastore/v1.rb
+- lib/google/cloud/datastore/v1/credentials.rb
 - lib/google/cloud/datastore/v1/datastore_client.rb
 - lib/google/cloud/datastore/v1/datastore_client_config.json
 - lib/google/cloud/datastore/v1/doc/google/datastore/v1/datastore.rb
 - lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb
 - lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb
 - lib/google/cloud/datastore/v1/doc/google/protobuf/wrappers.rb
-- lib/google/cloud/datastore/v1/doc/overview.rb
 - lib/google/cloud/datastore/version.rb
 - lib/google/datastore/v1/datastore_pb.rb
 - lib/google/datastore/v1/datastore_services_pb.rb
@@ -241,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Datastore

data/lib/google/cloud/datastore/v1/doc/overview.rb

@@ -1,54 +0,0 @@
-# Copyright 2017 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 Google
-  module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Google Cloud Datastore API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Google Cloud Datastore API][Product Documentation]:
-    # Accesses the schemaless NoSQL database to provide fully managed, robust,
-    # scalable storage for your application.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable the Google Cloud Datastore API.](https://console.cloud.google.com/apis/api/datastore)
-    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-datastore
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Google Cloud Datastore API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/datastore
-    #
-    #
-    module Datastore
-      module V1
-      end
-    end
-  end
-end