Fixes issues found in review.

gguuss · gguuss · commit 12c348798121 · 2017-05-22T17:20:56.000-07:00
diff --git a/iot/api-client/README.md b/iot/api-client/README.md
@@ -11,7 +11,7 @@ Google Cloud IoT Core platform.
 
 3. Add the special account `cloud-iot@system.gserviceaccount.com` to that
 PubSub topic from the [Cloud Developer Console](https://console.cloud.google.com)
-or by using the helper script in the /scripts folder.
+or by using the helper script in the [/scripts](./scripts) folder.
 
 4. Create a registry:
 
@@ -20,7 +20,7 @@ or by using the helper script in the /scripts folder.
         --region=us-central1 \
         --pubsub-topic=projects/my-iot-project/topics/device-events
 
-5. Use the `generate_keys.sh` script to generate your signing keys:
+5. Use the [`generate_keys.sh`](generate_keys.sh) script to generate your signing keys:
 
     ./generate_keys.sh
 
@@ -32,7 +32,7 @@ or by using the helper script in the /scripts folder.
         --registry=my-registry \
         --public-key path=rsa_cert.pem,type=rs256
 
-7. Connect a sample device using the sample app in the `mqtt_example` folder.
+7. Connect a sample device using the sample app in the [`mqtt_example`](./mqtt_example) folder.
 8. Learn how to manage devices programatically with the sample app in the
 `manager` folder.
 
diff --git a/iot/api-client/manager/README.md b/iot/api-client/manager/README.md
@@ -1,12 +1,19 @@
-# Cloud IoT Core Java Device Management example
+r)# Cloud IoT Core Java Device Management example
 
 This sample app demonstrates device management for Google Cloud IoT Core.
 
 Note that before you can run the sample, you must configure a Google Cloud
-PubSub topic for Cloud IoT as described in the parent README.
+PubSub topic for Cloud IoT as described in [the parent README](../README.md).
 
 ## Setup
 
+Manually install [the provided client library](https://cloud.google.com/iot/resources/java/cloud-iot-core-library.jar)
+for Cloud IoT Core to Maven:
+
+     mvn install:install-file -Dfile=cloud-iot-core-library.jar -DgroupId=com.google.apis \
+    -DartifactId=google-api-services-cloudiot -Dversion=v1beta1-rev20170418-1.22.0-SNAPSHOT \
+    -Dpackaging=jar
+
 Run the following command to install the libraries and build the sample with
 Maven:
 
diff --git a/iot/api-client/manager/pom.xml b/iot/api-client/manager/pom.xml
@@ -31,17 +31,6 @@
     <relativePath>../../../</relativePath>
   </parent>
 
-  <!-- Start local repo -->
-  <repositories>
-    <!-- Use a local directory for the Cloud IoT Core API dependency. -->
-    <repository>
-      <id>project.local</id>
-      <name>project</name>
-      <url>file:./repo</url>
-    </repository>
-  </repositories>
-  <!-- End of extra repo -->
-
   <properties>
     <maven.compiler.source>1.7</maven.compiler.source>
     <maven.compiler.target>1.7</maven.compiler.target>
diff --git a/iot/api-client/manager/repo/com/google/apis/google-api-services-cloudiot/maven-metadata.xml b/iot/api-client/manager/repo/com/google/apis/google-api-services-cloudiot/maven-metadata.xml
diff --git a/iot/api-client/manager/repo/com/google/apis/google-api-services-cloudiot/v1beta1-rev20170418-1.22.0-SNAPSHOT/maven-metadata.xml b/iot/api-client/manager/repo/com/google/apis/google-api-services-cloudiot/v1beta1-rev20170418-1.22.0-SNAPSHOT/maven-metadata.xml
diff --git a/iot/api-client/manager/src/main/java/com/google/cloud/iot/examples/DeviceRegistryExample.java b/iot/api-client/manager/src/main/java/com/google/cloud/iot/examples/DeviceRegistryExample.java
@@ -46,20 +46,15 @@
  * IoT devices and registries, using both RSA and eliptic curve keys for authentication.
  *
  * <p>To start, follow the instructions on the Developer Guide at cloud.google.com/iot to create a
- * service_account.json file. Also create a Cloud Pub/Sub topic as discussed in the guide. After
- * doing this, you should have service_account.json in your directory. Tell gcloud about this file
- * by setting it in an environment variable:
- *
- * <pre>
- * <code>
- * $ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
- * </code>
- * </pre>
+ * service_account.json file and Cloud Pub/Sub topic as discussed in the guide. You will then need
+ * to point to the service_account.json file as described in
+ * https://developers.google.com/identity/protocols/application-default-credentials#howtheywork
  *
  * <p>Before running the example, we have to create private and public keys, as described in
  * cloud.google.com/iot. Since we are interacting with the device manager, we will only use the
- * public keys. The private keys are used to sign JWTs to authenticate devices. See the MQTT client
- * example in the developer guide for an example of this.
+ * public keys. The private keys are used to sign JWTs to authenticate devices. See the
+ * <a href="https://github.com/GoogleCloudPlatform/java-docs-samples/tree/master/iot/api-client/mqtt_example">MQTT client example</a>
+ * for more information.
  *
  * <p>Finally, compile and run the example with:
  *
@@ -76,7 +71,7 @@
  * </pre>
  */
 public class DeviceRegistryExample {
-  // CloudIot service for administering Cloud IoT devices, registries and projects.
+  // Service for administering Cloud IoT Core devices, registries and projects.
   private CloudIot service;
   // Path to the project and location: "projects/my-project-id/locations/us-central1"
   private String projectPath;
@@ -255,7 +250,7 @@ public void modifyCloudToDeviceConfig(String deviceId, String configData) throws
     ModifyCloudToDeviceConfigRequest request = new ModifyCloudToDeviceConfigRequest();
     DeviceConfigData data = new DeviceConfigData();
     data.setBinaryData(DatatypeConverter.printBase64Binary(configData.getBytes(Charsets.UTF_8)));
-    request.setVersionToUpdate(0L);
+    request.setVersionToUpdate(0L); // 0L indicates update all versions
     request.setData(data);
     DeviceConfig config =
         service
diff --git a/iot/api-client/mqtt_example/README.md b/iot/api-client/mqtt_example/README.md
@@ -5,7 +5,7 @@ as part of Google Cloud IoT Core.
 
 Note that before you can run the sample, you must configure a Google Cloud
 PubSub topic for Cloud IoT Core and register a device as described in the
-parent README.
+[parent README](../README.md).
 
 ## Setup
 
@@ -27,8 +27,8 @@ The following command summarizes the sample usage:
 
 For example, if your project ID is `blue-jet-123`, your service account
 credentials are stored in your home folder in creds.json and you have generated
-your credentials using the shell script provided in the parent folder, you can
-run the sample as:
+your credentials using the [`generate_keys.sh`](../generate_keys.sh) script
+provided in the parent folder, you can run the sample as:
 
     mvn exec:java \
         -Dexec.mainClass="com.google.cloud.iot.examples.MqttExample" \
diff --git a/iot/api-client/mqtt_example/src/main/java/com/google/cloud/iot/examples/MqttExample.java b/iot/api-client/mqtt_example/src/main/java/com/google/cloud/iot/examples/MqttExample.java
@@ -25,8 +25,8 @@
  * <p>To run this example, first create your credentials and register your device as
  * described in the README located in the sample's parent folder.
  *
- * <p>After you have registered your device and generated ompile and run with the
- * corresponding algorithm flag, for example:
+ * <p>After you have registered your device and generated your credentials, compile and
+ * run with the corresponding algorithm flag, for example:
  *
  * <pre>
  *   $ mvn compile

Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,8 @@`
`25`	`25`	`* <p>To run this example, first create your credentials and register your device as`
`26`	`26`	`* described in the README located in the sample's parent folder.`
`27`	`27`	`*`
`28`		`- * <p>After you have registered your device and generated ompile and run with the`
`29`		`- * corresponding algorithm flag, for example:`
	`28`	`+ * <p>After you have registered your device and generated your credentials, compile and`
	`29`	`+ * run with the corresponding algorithm flag, for example:`
`30`	`30`	`*`
`31`	`31`	`* <pre>`
`32`	`32`	`* $ mvn compile`