google-cloud-datastore 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72ce967e2225a7f45b099b3183e72b450e2a424540423ccdbcecd3f04d4df5a7
-  data.tar.gz: 7bc5dc5ef826d16c6e3732ed496deacb53e239c3a0583fa46babeeb5253bc91c
+  metadata.gz: 264365e0f5bcb539fbcb7400f635ce7846da49d69d40ebd0dd4bd01e8337f82a
+  data.tar.gz: b63520b3c479e80a74d3f5343cecf957e369f99bf2b9aba687cef9d732c3aa46
 SHA512:
-  metadata.gz: 0babd961bc284b94502cb3dcccfa5da0fea60fd6277ca5c8da2a5527e9cde189d0d18eb1ac6d3b66f0f1676e81d0eddfdd5e068cbfe3a3da0c1f07e05651fb34
-  data.tar.gz: 03d6099865662209ce9824bfd3601391b78996d62377b34d80bbaff2c8f9b25fe04ff8c8563aa8fcdf24a000850d20df1243ddd96b963ca80a2906475ea1f421
+  metadata.gz: 388076fda8dfc3ee025da5346cd390d5db31659f8d859f6da73dd7621ecfd5e16a0c9edc90e8e83d3f4f8847a15cc05557ac8b5c06f939b566a1b87ee5b1de7f
+  data.tar.gz: 790522bf2b042596ed3c4196a37f8a40b5fd96221fae6c97046e02f59f4ef269e7aaf0c89418db385532a456654aade40fd09d88c413b351985faf9a5a67b246

data/AUTHENTICATION.md

@@ -2,20 +2,39 @@
 
 In general, the google-cloud-datastore library uses [Service
 Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running on Compute Engine
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
 the credentials will be discovered automatically. When running on other
 environments, the Service Account credentials can be specified by providing the
 path to the [JSON
 keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
-the account (or the JSON itself) in environment variables. Additionally, Cloud
-SDK credentials can also be discovered automatically, but this is only
-recommended during development.
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export DATASTORE_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/datastore"
+
+client = Google::Cloud::Datastore.new
+```
 
 ## Project and Credential Lookup
 
-The google-cloud-datastore library aims to make authentication as simple as
-possible, and provides several mechanisms to configure your system without
-providing **Project ID** and **Service Account Credentials** directly in code.
+The google-cloud-datastore library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
 
 **Project ID** is discovered in the following order:
 
@@ -23,6 +42,7 @@ providing **Project ID** and **Service Account Credentials** directly in code.
 2. Specify project ID in configuration
 3. Discover project ID in environment variables
 4. Discover GCE project ID
+5. Discover project ID in credentials JSON
 
 **Credentials** are discovered in the following order:
 
@@ -73,12 +93,12 @@ environment variable, or the **Credentials JSON** itself can be stored for
 environments such as Docker containers where writing files is difficult or not
 encouraged.
 
-The environment variables that Datastore checks for project ID are:
+The environment variables that google-cloud-datastore checks for project ID are:
 
 1. `DATASTORE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that 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::V1::Credentials}:
 
 1. `DATASTORE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `DATASTORE_KEYFILE` - Path to JSON file, or JSON contents
@@ -92,7 +112,7 @@ require "google/cloud/datastore"
 ENV["DATASTORE_PROJECT"]     = "my-project-id"
 ENV["DATASTORE_CREDENTIALS"] = "path/to/keyfile.json"
 
-datastore = Google::Cloud::Datastore.new
+client = Google::Cloud::Datastore.new
 ```
 
 ### Configuration
@@ -107,7 +127,7 @@ Google::Cloud::Datastore.configure do |config|
   config.credentials = "path/to/keyfile.json"
 end
 
-datastore = Google::Cloud::Datastore.new
+client = Google::Cloud::Datastore.new
 ```
 
 ### Cloud SDK
@@ -140,7 +160,8 @@ Google Cloud requires a **Project ID** and **Service Account Credentials** to
 connect to the APIs. You will use the **Project ID** and **JSON key file** to
 connect to most services with google-cloud-datastore.
 
-If you are not running this client on Google Compute Engine, you need a Google
+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].

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 1.5.2 / 2019-04-29
+
+* Add AUTHENTICATION.md guide.
+* Update generated documentation.
+* Extract gRPC header values from request.
+
 ### 1.5.1 / 2019-02-13
 
 * Add `ReadOnlyTransaction` convenience methods:

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

@@ -63,7 +63,7 @@ module Google
 
         # @private byte array as a string
         def to_grpc
-          Convert.decode_bytes(@cursor)
+          Convert.decode_bytes @cursor
         end
 
         # @private byte array as a string

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

@@ -296,7 +296,7 @@ module Google
           returned_keys = commit_res.mutation_results.map(&:key)
           returned_keys.each_with_index do |key, index|
             next if entities[index].nil?
-            entities[index].key = Key.from_grpc(key) unless key.nil?
+            entities[index].key = Key.from_grpc key unless key.nil?
           end
           entities.each { |e| e.key.freeze unless e.persisted? }
           entities
@@ -540,7 +540,7 @@ module Google
             raise err if Time.now - start_time > deadline
 
             # Sleep with incremental backoff
-            sleep(backoff *= 1.3)
+            sleep backoff *= 1.3
 
             # Create new transaction and retry the block
             tx = Transaction.new service, previous_transaction: tx.id

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

@@ -170,7 +170,7 @@ module Google
           def all request_limit: nil
             request_limit = request_limit.to_i if request_limit
             unless block_given?
-              return enum_for(:all, request_limit: request_limit)
+              return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do

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

@@ -211,7 +211,7 @@ module Google
           #   end
           #
           def each_with_cursor
-            return enum_for(:each_with_cursor) unless block_given?
+            return enum_for :each_with_cursor unless block_given?
             zip(cursors).each { |r, c| yield [r, c] }
           end
 
@@ -269,7 +269,7 @@ module Google
           def all request_limit: nil
             request_limit = request_limit.to_i if request_limit
             unless block_given?
-              return enum_for(:all, request_limit: request_limit)
+              return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
@@ -338,7 +338,7 @@ module Google
           def all_with_cursor request_limit: nil
             request_limit = request_limit.to_i if request_limit
             unless block_given?
-              return enum_for(:all_with_cursor, request_limit: request_limit)
+              return enum_for :all_with_cursor, request_limit: request_limit
             end
             results = self
 

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

@@ -277,9 +277,9 @@ module Google
             elsif pe_id_or_name.is_a? String
               path_args[:name] = pe_id_or_name unless pe_id_or_name.empty?
             end
-            Google::Datastore::V1::Key::PathElement.new(path_args)
+            Google::Datastore::V1::Key::PathElement.new path_args
           end
-          grpc = Google::Datastore::V1::Key.new(path: grpc_path)
+          grpc = Google::Datastore::V1::Key.new path: grpc_path
           if project || namespace
             grpc.partition_id = Google::Datastore::V1::PartitionId.new(
               project_id: project.to_s, namespace_id: namespace.to_s
@@ -305,7 +305,7 @@ module Google
             key.project = key_grpc.partition_id.project_id
             key.namespace = key_grpc.partition_id.namespace_id
           end
-          key.parent = Key.from_grpc(key_grpc) if key_grpc.path.count > 0
+          key.parent = Key.from_grpc key_grpc if key_grpc.path.count > 0
           # Freeze the key to make it immutable.
           key.freeze
           key

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

@@ -298,7 +298,7 @@ module Google
         #   tasks = datastore.run query
         #
         def limit num
-          @grpc.limit = Google::Protobuf::Int32Value.new(value: num)
+          @grpc.limit = Google::Protobuf::Int32Value.new value: num
 
           self
         end

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

@@ -333,7 +333,7 @@ module Google
           returned_keys = commit_res.mutation_results.map(&:key)
           returned_keys.each_with_index do |key, index|
             next if entities[index].nil?
-            entities[index].key = Key.from_grpc(key) unless key.nil?
+            entities[index].key = Key.from_grpc key unless key.nil?
           end
           # Make sure all entity keys are frozen so all show as persisted
           entities.each { |e| e.key.freeze unless e.persisted? }

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

@@ -169,37 +169,58 @@ module Google
             @lookup = Google::Gax.create_api_call(
               @datastore_stub.method(:lookup),
               defaults["lookup"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @run_query = Google::Gax.create_api_call(
               @datastore_stub.method(:run_query),
               defaults["run_query"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @begin_transaction = Google::Gax.create_api_call(
               @datastore_stub.method(:begin_transaction),
               defaults["begin_transaction"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @commit = Google::Gax.create_api_call(
               @datastore_stub.method(:commit),
               defaults["commit"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @rollback = Google::Gax.create_api_call(
               @datastore_stub.method(:rollback),
               defaults["rollback"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @allocate_ids = Google::Gax.create_api_call(
               @datastore_stub.method(:allocate_ids),
               defaults["allocate_ids"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @reserve_ids = Google::Gax.create_api_call(
               @datastore_stub.method(:reserve_ids),
               defaults["reserve_ids"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
           end
 

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

@@ -67,7 +67,8 @@ module Google
       #     The GQL query to run.
       class RunQueryRequest; end
 
-      # The response for {Google::Datastore::V1::Datastore::RunQuery Datastore::RunQuery}.
+      # The response for
+      # {Google::Datastore::V1::Datastore::RunQuery Datastore::RunQuery}.
       # @!attribute [rw] batch
       #   @return [Google::Datastore::V1::QueryResultBatch]
       #     A batch of query results (always present).
@@ -76,7 +77,8 @@ module Google
       #     The parsed form of the `GqlQuery` from the request, if it was set.
       class RunQueryResponse; end
 
-      # The request for {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
+      # The request for
+      # {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -85,7 +87,8 @@ module Google
       #     Options for a new transaction.
       class BeginTransactionRequest; end
 
-      # The response for {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
+      # The response for
+      # {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       # @!attribute [rw] transaction
       #   @return [String]
       #     The transaction identifier (always present).
@@ -101,8 +104,9 @@ module Google
       #     {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
       class RollbackRequest; end
 
-      # The response for {Google::Datastore::V1::Datastore::Rollback Datastore::Rollback}.
-      # (an empty message).
+      # The response for
+      # {Google::Datastore::V1::Datastore::Rollback Datastore::Rollback}. (an empty
+      # message).
       class RollbackResponse; end
 
       # The request for {Google::Datastore::V1::Datastore::Commit Datastore::Commit}.
@@ -139,7 +143,8 @@ module Google
           MODE_UNSPECIFIED = 0
 
           # Transactional: The mutations are either all applied, or none are applied.
-          # Learn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).
+          # Learn about transactions
+          # [here](https://cloud.google.com/datastore/docs/concepts/transactions).
           TRANSACTIONAL = 1
 
           # Non-transactional: The mutations may not apply as all or none.
@@ -158,7 +163,8 @@ module Google
       #     updated.
       class CommitResponse; end
 
-      # The request for {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
+      # The request for
+      # {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -168,14 +174,16 @@ module Google
       #     No key may be reserved/read-only.
       class AllocateIdsRequest; end
 
-      # The response for {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
+      # The response for
+      # {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
       # @!attribute [rw] keys
       #   @return [Array<Google::Datastore::V1::Key>]
       #     The keys specified in the request (in the same order), each with
       #     its key path completed with a newly allocated ID.
       class AllocateIdsResponse; end
 
-      # The request for {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
+      # The request for
+      # {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project against which to make the request.
@@ -188,7 +196,8 @@ module Google
       #     auto-allocated.
       class ReserveIdsRequest; end
 
-      # The response for {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
+      # The response for
+      # {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
       class ReserveIdsResponse; end
 
       # A mutation to apply to an entity.
@@ -259,8 +268,10 @@ module Google
       # Options for beginning a new transaction.
       #
       # Transactions can be created explicitly with calls to
-      # {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction} or implicitly by setting
-      # {Google::Datastore::V1::ReadOptions#new_transaction ReadOptions#new_transaction} in read requests.
+      # {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}
+      # or implicitly by setting
+      # {Google::Datastore::V1::ReadOptions#new_transaction ReadOptions#new_transaction}
+      # in read requests.
       # @!attribute [rw] read_write
       #   @return [Google::Datastore::V1::TransactionOptions::ReadWrite]
       #     The transaction should allow both reads and writes.

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

@@ -34,7 +34,8 @@ module Google
       #
       # Foreign partition IDs (in which the project ID does
       # not match the context project ID ) are discouraged.
-      # Reads and writes of foreign partition IDs may fail if the project is not in an active state.
+      # Reads and writes of foreign partition IDs may fail if the project is not in
+      # an active state.
       # @!attribute [rw] project_id
       #   @return [String]
       #     The ID of the project to which the entities belong.
@@ -128,8 +129,8 @@ module Google
       # @!attribute [rw] string_value
       #   @return [String]
       #     A UTF-8 encoded string value.
-      #     When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.
-      #     Otherwise, may be set to at least 1,000,000 bytes.
+      #     When `exclude_from_indexes` is false (it is indexed) , may have at most
+      #     1500 bytes. Otherwise, may be set to at least 1,000,000 bytes.
       # @!attribute [rw] blob_value
       #   @return [String]
       #     A blob value.

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

@@ -25,12 +25,12 @@ module Google
       #     The version of the entity, a strictly positive number that monotonically
       #     increases with changes to the entity.
       #
-      #     This field is set for {Google::Datastore::V1::EntityResult::ResultType::FULL `FULL`} entity
-      #     results.
+      #     This field is set for
+      #     {Google::Datastore::V1::EntityResult::ResultType::FULL `FULL`} entity results.
       #
-      #     For {Google::Datastore::V1::LookupResponse#missing missing} entities in `LookupResponse`, this
-      #     is the version of the snapshot that was used to look up the entity, and it
-      #     is always set except for eventually consistent reads.
+      #     For {Google::Datastore::V1::LookupResponse#missing missing} entities in
+      #     `LookupResponse`, this is the version of the snapshot that was used to look
+      #     up the entity, and it is always set except for eventually consistent reads.
       # @!attribute [rw] cursor
       #   @return [String]
       #     A cursor that points to the position after the result entity.
@@ -79,12 +79,14 @@ module Google
       #   @return [String]
       #     A starting point for the query results. Query cursors are
       #     returned in query result batches and
-      #     [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
+      #     [can only be used to continue the same
+      #     query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
       # @!attribute [rw] end_cursor
       #   @return [String]
       #     An ending point for the query results. Query cursors are
       #     returned in query result batches and
-      #     [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
+      #     [can only be used to limit the same
+      #     query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
       # @!attribute [rw] offset
       #   @return [Integer]
       #     The number of results to skip. Applies before limit, but after all other
@@ -201,7 +203,8 @@ module Google
         end
       end
 
-      # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
+      # A [GQL
+      # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
       # @!attribute [rw] query_string
       #   @return [String]
       #     A string of the format described

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -264,8 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Datastore