docs: add docs and samples #201

JustinBeckwith · 2017-12-01T01:23:24Z

This includes a few things:

Adds a few examples of using the API
Improves the README
~~Update to a working version of gtoken~~ (handled in fix: use urlencoded content-type for POST #203)
~~Fixes a few bugs with Content-Type~~ (handled in fix: use urlencoded content-type for POST #203)
~~Exposes objects as exports instead of relying on public properties on the GoogleAuth object~~ (handled in BREAKING CHANGE: export class types and remove properties from GoogleAuth #202)

ofrobots

Commit hygiene: this includes a fix but the abstract suggests that this is a docs-only change. The abstract would be wrong, as per conventional commit guidelines when this is landed. Secondly, even if you are not going to make separate PRs for fix vs. doc, it would be good to put these in separate commits to make reviewing easier. Ideally this should be separate PRs.

README.md

-level for the application independent of the user. This is the recommended approach to authorize
-calls to Cloud APIs, particularly when you're building an application that uses Google Compute
-Engine.
+They are best suited for cases when the call needs to have the same identity and authorization level for the application independent of the user. This is the recommended approach to authorize calls to Cloud APIs, particularly when you're building an application that uses Google Compute Engine.


README.md

+  // machine. In that case, the desired scopes must be passed in manually. When the code is
+  // running in GCE or a Managed VM, the scopes are pulled from the GCE metadata server.
+  // See https://cloud.google.com/compute/docs/authentication for more information.
+  if (client.createScopedRequired && client.createScopedRequired()) {


README.md

+ * Create a new OAuth2Client, and go through the OAuth2 content
+ * workflow.  Return the full client to the callback.
+ */
+async function getAuthenticatedClient() {


examples/adc.js

+  }
+}
+
+main();


examples/jwt.js

+  return client;
+}
+
+main();


examples/oauth2.js

+  });
+}
+
+main();


JustinBeckwith · 2017-12-01T19:06:45Z

@ofrobots yeah, I kind of started this PR without intending to make those changes, but it just kinda happened. I split the origin contents of this one out into #202 (which landed) and #203 (which could use a review). After that lands, I'll rebase this to be true docs/samples only.

JustinBeckwith · 2017-12-02T05:31:31Z

Also, addresses #196

README.md

+Before making your API call, you must be sure the API you're calling has been enabled. Go to **APIs & Auth** > **APIs** in the [Google Developers Console][devconsole] and enable the APIs you'd like to call. For the example below, you must enable the `DNS API`.
+
+
+#### Choosing the correct credential type automatically


README.md

+  try {
+    const adc = await getADC();
+    const url = `https://www.googleapis.com/dns/v1/projects/${adc.projectId}`;
+    const res = await adc.client.request({url});


README.md

+
+This client comes with an [OAuth2][oauth] client that allows you to retrieve an access token and refreshes the token and retry the request seamlessly if you also provide an `expiry_date` and the token is expired. The basics of Google's OAuth2 implementation is explained on [Google Authorization and Authentication documentation][authdocs].
+
+In the following examples, you may need a `CLIENT_ID`, `CLIENT_SECRET` and `REDIRECT_URL`. You can find these pieces of information by going to the [Developer Console][devconsole], clicking your project --> APIs & auth --> credentials.


JustinBeckwith · 2017-12-19T22:19:30Z

Note: test failures are unrelated, and fixed in #209

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Dec 1, 2017

JustinBeckwith requested review from ofrobots and a team December 1, 2017 01:23

ofrobots reviewed Dec 1, 2017

View reviewed changes

ofrobots mentioned this pull request Dec 1, 2017

Update gtoken to the latest version 🚀 #200

Closed

JustinBeckwith mentioned this pull request Dec 2, 2017

Possible to add keep-alive agent to request? #167

Closed

ofrobots reviewed Dec 19, 2017

View reviewed changes

ofrobots approved these changes Dec 20, 2017

View reviewed changes

JustinBeckwith added 4 commits December 20, 2017 15:47

docs: add docs and samples

fc5ed24

remove async if not needed

e0b463c

add link to release notes

4d173e1

PR feedback

3c7ef48

JustinBeckwith merged commit 61b6747 into googleapis:next Dec 21, 2017

JustinBeckwith mentioned this pull request Dec 21, 2017

Update docs in the next branch #196

Closed

ofrobots pushed a commit that referenced this pull request Jan 9, 2018

docs: add docs and samples (#201)

e74d66f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add docs and samples #201

docs: add docs and samples #201

JustinBeckwith commented Dec 1, 2017 •

edited

Loading

ofrobots left a comment •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Dec 1, 2017

JustinBeckwith commented Dec 2, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Dec 19, 2017

+                }
+              }
+              main();

+                });
+              }
+              main();

		Before making your API call, you must be sure the API you're calling has been enabled. Go to APIs & Auth > APIs in the [Google Developers Console][devconsole] and enable the APIs you'd like to call. For the example below, you must enable the `DNS API`.


		#### Choosing the correct credential type automatically


		This client comes with an [OAuth2][oauth] client that allows you to retrieve an access token and refreshes the token and retry the request seamlessly if you also provide an `expiry_date` and the token is expired. The basics of Google's OAuth2 implementation is explained on [Google Authorization and Authentication documentation][authdocs].

		In the following examples, you may need a `CLIENT_ID`, `CLIENT_SECRET` and `REDIRECT_URL`. You can find these pieces of information by going to the [Developer Console][devconsole], clicking your project --> APIs & auth --> credentials.

docs: add docs and samples #201

docs: add docs and samples #201

Conversation

JustinBeckwith commented Dec 1, 2017 • edited Loading

ofrobots left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Dec 1, 2017

JustinBeckwith commented Dec 2, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JustinBeckwith commented Dec 19, 2017

JustinBeckwith commented Dec 1, 2017 •

edited

Loading

ofrobots left a comment •

edited

Loading