Tidying up.

Author: jeremy-j-ackso

README.md

@@ -44,7 +44,7 @@ phaxio.faxes.create({
     // The `create` method returns a fax object with methods attached to it for doing things
     // like cancelling, resending, getting info, etc.
 
-    // Wait 5 seconds, then get the status of the fax by getting its info from the API.
+    // Wait 5 seconds to let the fax send, then get the status of the fax by getting its info from the API.
     return setTimeout(() => {
       fax.getInfo()
     }, 5000)
@@ -72,7 +72,7 @@ phaxio.faxes.listFaxes({ direction: 'sent' })
 Phaxio methods are categorized according to the Phaxio API route that they target.
 See the [Phaxio Docs]('https://www.phaxio.com/docs/api/v2.1/') for more information about the raw API.
 
-**All** Phaxio methods take one argument: either a single argument such as an ID, or an Object containing
+**All Phaxio methods take one argument:** either a single argument such as an ID, or an Object containing
 `key: value` parameters.
 See the documentation below for specifics.
 
@@ -162,7 +162,7 @@ The methods attached to a Fax Object take one or no arguments as they already ha
 | `faxObject.cancel()` | None | Cancels the fax. |
 | `faxObject.resend()` | `callback_url` (optional) | Resends the fax. Default `callback_url` uses the fax's original `callback_url`. Passing a URL string will set the `callback_url` to the new value. |
 | `faxObject.getInfo()` | None | Gets the fax's metadata information. |
-| `faxObject.getFile()` | `thumbnail` (optional) | Gets the fax's document. The default `thumbnail` is `null`, which gets the full file. Specify a string, `'s'` or `'l'`, to get a small or large thumbnail (respectively) of the first page of the document. |
+| `faxObject.getFile()` | `thumbnail` (optional) | Gets the fax's document. The default `thumbnail` is `null`, which gets the full PDF file. Specify a string, `'s'` or `'l'`, to get a small or large JPG thumbnail (respectively) of the first page of the document. |
 | `faxObject.deleteFile()` | None | Deletes a document associated with a fax. |
 | `faxObject.testDelete()` | None | Deletes a fax created using Test API Credentials. |
 
@@ -186,6 +186,14 @@ phaxio.faxes.create({ to: '+1234567890', content_url: 'https://google.com' })
   })
   .then(() => console.log('Insert successful.'))
   .catch((err) => { throw err; });
+
+// Write out the thumbnail of a created fax to a file.
+phaxio.faxes.create({ to: '+1234567890', content_url: 'https://google.com' })
+  .then((faxObject) => {
+    return faxObject.getFile('s')
+  })
+  .then(fileString => fs.writeFileSync(`${__dirname}/thumbnail.jpg`, fileString))
+  .catch((err) => { throw err; });
 ```
 
 #### `phaxio.faxes.cancel()`
@@ -253,7 +261,7 @@ Arguments (Object):
 
 ```javascript
 phaxio.faxes.getFile({ id: 987 })
-  .then(response => console.log(JSON.stringify(response, null, 2)))
+  .then(fileString => fs.writeFileSync(`${__dirname}/full_file.pdf`, fileString))
   .catch((err) => { throw err; });
 ```
 
@@ -488,7 +496,9 @@ To run the test suite:
 npm run test
 ```
 
+Note: this test suite uses `setTimeout()` to reduce the likelihood of receiving rate limiting errors.
+
 # LICENSE
 MIT Copyright 2018 Phaxio
 
-See LICENSE file for full detail.
+See `LICENSE` file for full detail.

m.png

@@ -1,7 +1,7 @@
 {
   "name": "phaxio-official",
   "version": "0.1.0",
-  "description": "The official Node.JS library for talking with the Phaxio API v2.1.0. https://phaxio.com",
+  "description": "The official Node.JS library for the Phaxio API v2.1.0. https://phaxio.com",
   "main": "index.js",
   "scripts": {
     "test": "mocha --exit --recursive --no-colors"

package.json

@@ -38,11 +38,10 @@ describe('shared methods', function () { // eslint-disable-line func-names
         .then((ores) => { // eslint-disable-line arrow-body-style
           const res = JSON.parse(ores);
           firstFax = res.data.id;
-          return getInfo(url, res.data.id, auth)
-            .then((gi) => {
-              expect(gi.success).to.be.ok();
-            })
-            .catch((err) => { throw err; });
+          return getInfo(url, res.data.id, auth);
+        })
+        .then((gi) => {
+          expect(gi.success).to.be.ok();
         })
         .catch((err) => { throw err; });
     });
@@ -63,11 +62,10 @@ describe('shared methods', function () { // eslint-disable-line func-names
       return req
         .then((ores) => { // eslint-disable-line arrow-body-style
           const res = JSON.parse(ores);
-          return cancel(url, res.data.id, auth)
-            .then((canc) => {
-              expect(canc.success).to.be.ok();
-            })
-            .catch((err) => { throw err; });
+          return cancel(url, res.data.id, auth);
+        })
+        .then((canc) => {
+          expect(canc.success).to.be.ok();
         })
         .catch((err) => { throw err; });
     });

test/faxes/shared-methods.test.js

@@ -21,6 +21,7 @@ describe('class: PhoneNumber', function () {
     describe('post-instantiation', () => {
       let phoneNumber;
       let sampleNumber;
+
       before(() => {
         phoneNumber = new PhoneNumber(process.env.TEST_APIKEY, process.env.TEST_APISECRET, 'https://api.phaxio.com/v2.1');
       });