google-cloud-firestore-v1 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fc7b1061d772309aac4bebedefa816d45e99778f3dbcd49647df48fef278f4b
-  data.tar.gz: beb8a8743ca3cb8854272d13b8007af61c6a2511d4d7403eb0574b8b22917858
+  metadata.gz: bd8c5117167e630dbb3e396da647c0aef398fd168f3aa7fa7b4d4e0bf0b37406
+  data.tar.gz: 42a8a4c062a1c3325e421ab2b8376ca987193f8ccba3ec96dee8e530a2a3abbb
 SHA512:
-  metadata.gz: 4ddf4cb3d52602fb8ae5a279755c2959fc8e7fe875d0ed0b1591f47a2ba0b5ebe090f511c981d96afb8fb1542799fae67edc93686e147e54a251c82733fd2ce4
-  data.tar.gz: 266a6b5243e9effad76151e50996d95949bfbe8c974dc2118a0d139bd7eec366b2ccc77c6eb3da430cacfee6db20e921759ea1519773d7a72ad095712f692c59
+  metadata.gz: 935861b273a177c48be6f1559073a31fcb9f63bbff327950a72d54fbb141be6fa3408932ede9a4dd451b35f77daa6ef5f23ceb4f2f0457987fe0680b8d6faf65
+  data.tar.gz: e1a8cbb46fdc786a38faa7612bdb9970573e9dfddf633fb62e3fe0d9164440bf130499a53cb1562ab3805e18a3cd5dbbb17abfe37283ac318bea20a80719221a

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Cloud Firestore V1 API
+--title="Cloud Firestore V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-firestore-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Firestore::V1::Firestore::Credentials}):
 
-1. `FIRESTORE_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `FIRESTORE_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `FIRESTORE_CREDENTIALS` - Path to JSON file, or JSON contents
+* `FIRESTORE_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/firestore/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Firestore::V1::Firestore::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/firestore/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Firestore::V1::Firestore::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/firestore/v1"
@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ 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].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/README.md

@@ -33,11 +33,11 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/firestore/v1"
 
 client = ::Google::Cloud::Firestore::V1::Firestore::Client.new
-request = my_create_request
+request = ::Google::Cloud::Firestore::V1::GetDocumentRequest.new # (request fields as keyword arguments...)
 response = client.get_document request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-firestore-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/firestore)
@@ -69,6 +69,11 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.5+.