Merge pull request #25 from NYPL/scc-4022-node20

SCC-4022 : Node20

Author: nonword

.env.example .env-example.env.example renamed to .env-example

@@ -1,5 +1,3 @@
-AWS_ACCESS_KEY_ID=[snip]
-AWS_SECRET_ACCESS_KEY=[snip]
 NYPL_API_BASE_URL=[https://url-to-our-playform.example.com/api/v0.1/]
 LOG_LEVEL=error
 NYPL_OAUTH_KEY=[an-oauth-key]

.gitignore

@@ -2,4 +2,6 @@
 node_modules
 
 # OAUTH keys & other vars:
-.env
+.env*
+# Allow the example file:
+!.env-example

.nvmrc

@@ -1 +1 @@
-6.17.1
+20

.travis.yml

@@ -1,3 +1,4 @@
 language: node_js
 install: npm install
 script: npm test
+dist: jammy

README.md

@@ -1,11 +1,9 @@
 # NYPL Data API Client
 
-Helper lib for interacting with the (internal) NYPL Data API
+Node module for interacting with the NYPL Platform API
 
 ## Installation
 
-Install it via npm for use inside your project:
-
 ```js
 npm i @nypl/nypl-data-api-client --save
 ```
@@ -35,106 +33,98 @@ See [usage.md](usage.md) for complete documentation of Client methods and use.
 To authenticate and fetch a bib (all GETs authenticate first, by default):
 
 ```js
-client.get('bibs/sierra-nypl/17746307').then((resp) => {
-  let bib = resp.data
-  console.log('Got bib: ' + bib.title)
-}).catch((e) => console.error('Error authenticating or fetching bib: ', e))
+  try {
+    const resp = await client.get('bibs/sierra-nypl/17746307')
+    const bib = resp.data
+    console.log('Got bib: ' + bib.title)
+  } catch (e) => {
+    console.error('Error authenticating or fetching bib: ', e)
+  }
 ```
 
 To get the "Item" stream schema, which doesn't require authentication:
 ```js
-client.get('current-schemas/Item', { authenticate: false }).then((resp) => {
-  let schema = resp.data
+  const resp = await client.get('current-schemas/Item', { authenticate: false })
+  const schema = resp.data
   // Now we can build an avro encoder by parsing the escaped "schema" prop:
-  var avroType = require('avsc').parse(JSON.parse(schema.schema))
-})
+  const avroType = require('avsc').parse(JSON.parse(schema.schema))
 ```
 
 To get patron id `12345678` (note you must auth with an account that has the 'read:patron' role):
 ```js
-client.get('patrons/12345678').then((resp) => {
-  let patron = resp.data
-  if (!patron) console.error('Could not find patron')
-  else {
-    var pType = Object.keys(patron.fixedFields).map((key) => patron.fixedFields[key])
-      .filter((fixed) => fixed.label === 'Patron Type')[0]
-      .value
-    var name = patron.names[0]
-    var barcode = patron.barCodes[0]
-
-    console.log('Patron:')
-    console.log('  Name: ' + name)
-    console.log('  Barcode: ' + barcode)
-    console.log('  Patron Type: ' + pType)
-  }
-})
+  const resp = await client.get('patrons/12345678')
+  const patron = resp.data
+  if (!patron) throw new Error('Could not find patron')
+
+  const pType = Object.keys(patron.fixedFields).map((key) => patron.fixedFields[key])
+    .filter((fixed) => fixed.label === 'Patron Type')[0]
+    .value
+  var name = patron.names[0]
+  var barcode = patron.barCodes[0]
+
+  console.log('Patron:')
+  console.log('  Name: ' + name)
+  console.log('  Barcode: ' + barcode)
+  console.log('  Patron Type: ' + pType)
 ```
 
 To POST a new "TestSchema" schema:
 ```js
-client.post('schemas/TestSchema', { name: "TestSchema", type: "record", fields: [ ... ] })
-  .then((resp) => {
-    if (JSON.parse(resp).data.stream !== 'TestSchema') throw Error('Error creating schema...')
-  })
+  const resp = await client.post('schemas/TestSchema', { name: "TestSchema", type: "record", fields: [ ... ] })
+  if (resp.data.stream !== 'TestSchema') throw Error('Error creating schema...')
 ```
 
 ## CLI
 
 A small CLI exists for common tasks.
 
-If installed globally (i.e. `npm i -g @nypl/nypl-data-api-client`), it can be run as follows:
+Set up:
 
-```js
-nypl-data-api
+```
+git clone git@github.com:NYPL/node-nypl-data-api-client.git
+cd node-nypl-data-api-client
+nvm use; npm i
+
+cp .env-example .env
+# Fill in missing details in .env
 ```
 
-For local installs, it can be run via local `node_modules`:
+To fetch the first 25 bibs:
 
 ```js
-./node_modules/.bin/nypl-data-api
+./bin/nypl-data-api.js get bibs
 ```
 
-To get help with any command run:
+To fetch a specific bib:
 
 ```js
-nypl-data-api help [command]
+./bin/nypl-data-api.js get bibs/sierra-nypl/11040445
 ```
 
-Note that the cli uses the following environment variables, read by default from `.env`:
+To create a hold-request:
 
- - NYPL_API_BASE_URL
- - NYPL_OAUTH_KEY
- - NYPL_OAUTH_SECRET
- - NYPL_OAUTH_URL
-
-See `.env.example` for a sample `.env` file. To specify a different `.env`, use the `--envfile` param (e.g. `--envfile config/qa.env`)
+```js
+./bin/nypl-data-api.js post hold-requests '{ "record": "1234", "patron": ... }'
+```
 
-### Schema post
+To specify a different `.env`, use the `--envfile` param (e.g. `--envfile .env-qa`)
 
-Run the following to upload the content of the given jsonfile to `schemas/[name]`
+A special `schema` command is provided for updating schemas. To post a new schema, run the following to upload the content of the given jsonfile to `schemas/[name]`
 
 ```js
-nypl-data-api schema post [name] [jsonfile]
+./bin/nypl-data-api.js schema post [name] [jsonfile]
 ```
 
 ## Contributing
 
-1. Cut feature branch from `master`
-2. After review, merge to `master`
+1. Cut feature branchs from `main`
+2. After review, merge to `main`
 3. Bump version in `package.json` & note changes in `CHANGELOG.md`
 4. `git tag -a v[version]`
 5. `npm publish`
 
 ## Testing
 
-All tests work offline with `request` and `oauth` stubs:
-
 ```js
 npm test
 ```
-
-If you want to run the test suite against real infrastructure, you can do so as follows:
-
-```js
-USE_CREDENTIALS=[credentials file, e.g. '.env'] npm test
-```