google-cloud-firestore-v1 0.4.2 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b142502a0188e2e275037266c5f59f45d08bb08025229b49ec1672b1564c5c35
-  data.tar.gz: 6f0ba25683a831e0c14dc6fd493eb24c86f918004446e198e4ce292658147f9d
+  metadata.gz: 4feb728a289d76179ce2a815cd9cda728103a36678cc02d90dfe2013ed82a77f
+  data.tar.gz: 8b137c2fff1b0db9774086d02cd69432bad57ce6c3bcd6b4d119b1a4fa07cf96
 SHA512:
-  metadata.gz: da3862cad7a0f1a855ff3fb925790e73b8763bd5d4356073ff7c263438f1f2fe71216c24b13cef119fe417b0966bcb72acfa44f51f1cb8d6b1d93610001d5f75
-  data.tar.gz: fcec5926bfdbea2a53dafbb67c5d56b5a495f8614f249bb43619b3b840e562ac2e3e1c2a7baacbf73fd17c09f14d54eef46fb279aa42efeda0d1e833086374e2
+  metadata.gz: 994499fbfb3778eb17fb88fd238796acb413337d4fbb63a43275198c5811eabb52361ae9f716876e7694634f58a88ece72aae59c1ac4b6aff857e26d524754bb
+  data.tar.gz: e549974988be248e4fd71fd7f29bcd87b0a9489f97bd4352185b631e8a2d80d1861d5ef57c501259d70f2cba3276aeae801d0f61215a2317358a98bdbd76570f

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,7 +33,7 @@ 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
 ```