google-cloud-datastore 0.24.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d7ce2752911ea72c137a1552380d6b632a12b3b
-  data.tar.gz: bdedcee6506cc84157a121a1c5ac6a6f3e030a10
+  metadata.gz: 559613c74ca35117a66212cce1a9ad90a1e5ccc2
+  data.tar.gz: 0c4f32aeeb33dfe3d9f3f180e259fb84b3064798
 SHA512:
-  metadata.gz: e8c1641e321e73292306a5c697152cb2db76f81c09aefa47aece7935e7148ebcdf9366da58fab1706624b052add2ccdac859de50c475558013dbcd5233126e31
-  data.tar.gz: 31699feb662ad45832583c3e443cd11650856cd86f5e4fbda97970dccbd7ec84dc3cdfedee827ad5cb73f3b2828becf3cbe0d8526bc40065a4170d9a3f2e0ee3
+  metadata.gz: eb046b91614d0fc04a8709684f1df2de02f573f6b5ddb9e275b2d9b705666c8ae55269d276dd3b650495315b57c6d1150ad46d9fbfd09ec3f641d9cbe5b110ba
+  data.tar.gz: 26a675b75579cf7edc42f0c4178fc821c865e567da3c279dbc95a0c42dc89c8f2885e7d28443f307150008b5f91b7a531d5ceed57508f94c0702c4df18891080

data/README.md

@@ -4,7 +4,7 @@
 
 Follow the [activation instructions](https://cloud.google.com/datastore/docs/activate) to use the Google Cloud Datastore API with your project.
 
-- [google-cloud-datastore API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-datastore/master/google/cloud/datastore)
+- [google-cloud-datastore API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-datastore/latest)
 - [google-cloud-datastore on RubyGems](https://rubygems.org/gems/google-cloud-datastore)
 - [Google Cloud Datastore documentation](https://cloud.google.com/datastore/docs)
 

data/lib/google/cloud/datastore.rb

@@ -61,7 +61,7 @@ module Google
     # Records, called "entities" in Datastore, are retrieved by using a key.
     # The key is more than a numeric identifier, it is a complex data structure
     # that can be used to model relationships. The simplest key has a string
-    # <tt>kind</tt> value, and either a numeric <tt>id</tt> value, or a string
+    # <tt>kind</tt> value and either a numeric <tt>id</tt> value or a string
     # <tt>name</tt> value. A single record can be retrieved by calling
     # {Google::Cloud::Datastore::Dataset#find} and passing the parts of the key:
     #
@@ -130,6 +130,21 @@ module Google
     # tasks = datastore.run query
     # ```
     #
+    # When using Datastore in a multitenant application, a query may be run
+    # within a namespace using the `namespace` option. (See
+    # [Multitenancy](https://cloud.google.com/datastore/docs/concepts/multitenancy))
+    #
+    # ```ruby
+    # require "google/cloud/datastore"
+    #
+    # datastore = Google::Cloud::Datastore.new
+    #
+    # query = datastore.query("Task").
+    #   where("done", "=", false)
+    #
+    # tasks = datastore.run query, namespace: "example-ns"
+    # ```
+    #
     # Records' key structures can also be queried.
     # (See {Google::Cloud::Datastore::Query#ancestor})
     #
@@ -161,7 +176,7 @@ module Google
     #
     # query = datastore.query("Task")
     # tasks = datastore.run query
-    # tasks.all do |task|
+    # tasks.all do |t|
     #   puts t["description"]
     # end
     # ```
@@ -242,8 +257,8 @@ module Google
     #
     # Entities hold properties. A property has a name that is a string or
     # symbol, and a value that is an object. Most value objects are supported,
-    # including String, Integer, Date, Time, and even other entity or key
-    # objects. Changes to the entity's properties are persisted by calling
+    # including `String`, `Integer`, `Date`, `Time`, and even other entity or
+    # key objects. Changes to the entity's properties are persisted by calling
     # {Google::Cloud::Datastore::Dataset#save}.
     #
     # ```ruby
@@ -302,7 +317,7 @@ module Google
     #
     # ## Transactions
     #
-    # Complex logic can be wrapped in a Transaction. All queries and updates
+    # Complex logic can be wrapped in a transaction. All queries and updates
     # within the {Google::Cloud::Datastore::Dataset#transaction} block are run
     # within the transaction scope, and will be automatically committed when the
     # block completes.

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/core/environment"
+require "google/cloud/env"
 require "google/cloud/datastore/convert"
 require "google/cloud/datastore/credentials"
 require "google/cloud/datastore/service"
@@ -35,10 +35,9 @@ module Google
       # Dataset is the data saved in a project's Datastore.
       # Dataset is analogous to a database in relational database world.
       #
-      # Google::Cloud::Datastore::Dataset is the main object for interacting
-      # with Google Datastore. {Google::Cloud::Datastore::Entity} objects are
-      # created, read, updated, and deleted by
-      # Google::Cloud::Datastore::Dataset.
+      # Dataset is the main object for interacting with Google Datastore.
+      # {Google::Cloud::Datastore::Entity} objects are created, read, updated,
+      # and deleted by Dataset.
       #
       # See {Google::Cloud#datastore}
       #
@@ -89,7 +88,7 @@ module Google
             ENV["DATASTORE_PROJECT"] ||
             ENV["GOOGLE_CLOUD_PROJECT"] ||
             ENV["GCLOUD_PROJECT"] ||
-            Google::Cloud::Core::Environment.project_id
+            Google::Cloud.env.project_id
         end
 
         ##
@@ -430,7 +429,7 @@ module Google
         #
         #   query = datastore.query("Task").
         #     where("done", "=", false)
-        #   tasks = datastore.run query, namespace: "ns~todo-project"
+        #   tasks = datastore.run query, namespace: "example-ns"
         #
         # @example Run the query with a GQL string.
         #   require "google/cloud/datastore"
@@ -448,7 +447,7 @@ module Google
         #
         #   gql_query = datastore.gql "SELECT * FROM Task WHERE done = @done",
         #                             done: false
-        #   tasks = datastore.run gql_query, namespace: "ns~todo-project"
+        #   tasks = datastore.run gql_query, namespace: "example-ns"
         #
         def run query, namespace: nil, consistency: nil
           ensure_service!
@@ -676,10 +675,10 @@ module Google
         #
         #   key = datastore.key ["TaskList", "default"], ["Task", "sampleTask"],
         #                       project: "my-todo-project",
-        #                       namespace: "ns~todo-project"
+        #                       namespace: "example-ns"
         #   key.path #=> [["TaskList", "default"], ["Task", "sampleTask"]]
         #   key.project #=> "my-todo-project"
-        #   key.namespace #=> "ns~todo-project"
+        #   key.namespace #=> "example-ns"
         #
         def key *path, project: nil, namespace: nil
           path = path.flatten.each_slice(2).to_a # group in pairs

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

@@ -47,7 +47,7 @@ module Google
         #   tasks.size #=> 3
         #   tasks.deferred #=> []
         #   tasks.missing #=> []
-        #   descriptions = tasks.map { |task| task["description"] }
+        #   descriptions = tasks.map { |t| t["description"] }
         #   descriptions.size #=> 3
         #   descriptions.deferred #=> raise NoMethodError
         #   descriptions.missing #=> raise NoMethodError
@@ -140,8 +140,8 @@ module Google
           #   task_key1 = datastore.key "Task", "sampleTask1"
           #   task_key2 = datastore.key "Task", "sampleTask2"
           #   tasks = datastore.find_all task_key1, task_key2
-          #   tasks.all do |task|
-          #     puts "Task #{task.key.id} (#cursor)"
+          #   tasks.all do |t|
+          #     puts "Task #{t.key.id} (#cursor)"
           #   end
           #
           # @example Using the enumerator by not passing a block:
@@ -162,8 +162,8 @@ module Google
           #   task_key1 = datastore.key "Task", "sampleTask1"
           #   task_key2 = datastore.key "Task", "sampleTask2"
           #   tasks = datastore.find_all task_key1, task_key2
-          #   tasks.all(request_limit: 10) do |task|
-          #     puts "Task #{task.key.id} (#cursor)"
+          #   tasks.all(request_limit: 10) do |t|
+          #     puts "Task #{t.key.id} (#cursor)"
           #   end
           #
           def all request_limit: nil

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

@@ -49,7 +49,7 @@ module Google
         #
         #   tasks.size #=> 3
         #   tasks.cursor.to_s #=> "c2Vjb25kLXBhZ2UtY3Vyc29y"
-        #   descriptions = tasks.map { |task| task["description"] }
+        #   descriptions = tasks.map { |t| t["description"] }
         #   descriptions.size #=> 3
         #   descriptions.cursor #=> raise NoMethodError
         #
@@ -239,8 +239,8 @@ module Google
           #
           #   query = datastore.query "Task"
           #   tasks = datastore.run query
-          #   tasks.all do |task|
-          #     puts "Task #{task.key.id} (#cursor)"
+          #   tasks.all do |t|
+          #     puts "Task #{t.key.id} (#cursor)"
           #   end
           #
           # @example Using the enumerator by not passing a block:
@@ -261,8 +261,8 @@ module Google
           #
           #   query = datastore.query "Task"
           #   tasks = datastore.run query
-          #   tasks.all(request_limit: 10) do |task|
-          #     puts "Task #{task.key.id} (#cursor)"
+          #   tasks.all(request_limit: 10) do |t|
+          #     puts "Task #{t.key.id} (#cursor)"
           #   end
           #
           def all request_limit: nil

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

@@ -24,6 +24,9 @@ module Google
       # either a key name string, assigned explicitly by the application, or an
       # integer numeric ID, assigned automatically by Datastore.
       #
+      # @see https://cloud.google.com/datastore/docs/concepts/entities Entities,
+      #   Properties, and Keys
+      #
       # @example
       #   require "google/cloud/datastore"
       #
@@ -78,7 +81,7 @@ module Google
         #   )
         #
         #   task = datastore.find "Task", "sampleTask"
-        #   task.key.namespace #=> "ns~todo-project"
+        #   task.key.namespace #=> "example-ns"
         #
         attr_accessor :namespace
 

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

@@ -42,6 +42,15 @@ module Google
       #
       #   tasks = datastore.run query
       #
+      # @example Run the query within a namespace with the `namespace` option:
+      #   require "google/cloud/datastore"
+      #
+      #   datastore = Google::Cloud::Datastore.new
+      #
+      #   query = datastore.query("Task").
+      #     where("done", "=", false)
+      #   tasks = datastore.run query, namespace: "example-ns"
+      #
       class Query
         ##
         # Returns a new query object.
@@ -354,9 +363,9 @@ module Google
         #
         #   priorities = []
         #   percent_completes = []
-        #   datastore.run(query).each do |task|
-        #     priorities << task["priority"]
-        #     percent_completes << task["percent_complete"]
+        #   datastore.run(query).each do |t|
+        #     priorities << t["priority"]
+        #     percent_completes << t["percent_complete"]
         #   end
         #
         # @example A keys-only query using the special property `__key__`:

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

@@ -258,7 +258,7 @@ module Google
         #   query = Google::Cloud::Datastore::Query.new.kind("Task").
         #     where("done", "=", false)
         #   datastore.transaction do |tx|
-        #     tasks = tx.run query, namespace: "ns~todo-project"
+        #     tasks = tx.run query, namespace: "example-ns"
         #   end
         #
         def run query, namespace: nil

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

@@ -1,10 +1,10 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # 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
 #
-# http://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,
@@ -26,6 +26,7 @@ require "json"
 require "pathname"
 
 require "google/gax"
+
 require "google/datastore/v1/datastore_pb"
 
 module Google
@@ -277,10 +278,6 @@ module Google
           #   The ID of the project against which to make the request.
           # @param mode [Google::Datastore::V1::CommitRequest::Mode]
           #   The type of commit to perform. Defaults to +TRANSACTIONAL+.
-          # @param transaction [String]
-          #   The identifier of the transaction associated with the commit. A
-          #   transaction identifier is returned by a call to
-          #   Datastore::BeginTransaction.
           # @param mutations [Array<Google::Datastore::V1::Mutation>]
           #   The mutations to perform.
           #
@@ -295,6 +292,10 @@ module Google
           #
           #   When mode is +NON_TRANSACTIONAL+, no two mutations may affect a single
           #   entity.
+          # @param transaction [String]
+          #   The identifier of the transaction associated with the commit. A
+          #   transaction identifier is returned by a call to
+          #   Datastore::BeginTransaction.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.

data/lib/google/cloud/datastore/v1/datastore_client_config.json

@@ -6,7 +6,9 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": []
+        "non_idempotent": [
+          "UNAVAILABLE"
+        ]
       },
       "retry_params": {
         "default": {

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Datastore
-      VERSION = "0.24.2"
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 0.24.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Datastore