Fixes missing array in body request and exposes programmatic usage (#33)

README.md

@@ -141,6 +141,40 @@ Usage: godaddy-dns [options]
     -i, --ipfile [file]  specify which file to use to store the last found ip (default "<user temp folder>/.lastip")
 ```
 
+
+## Programmatic usage
+
+If you want to use the features of this module in a Node.js project:
+
+```javascript
+const dns = require("godaddy-dns");
+
+dns.getCurrentIp().then((currentIp)=>{
+  console.log("Current ip",currentIp);
+
+  dns.updateRecords(currentIp,{
+    "apiKey": "",
+    "secret": "",
+    "domain": "example.com",
+    "records": [
+      {"type": "A", "name": "@", "ttl": 600}
+    ]
+  })
+  .then(() => {
+    console.log(`[${new Date()}] Successfully updated DNS records to ip ${currentIp}`)
+  })
+  .catch((err) => {
+    if (err && err.message !== 'Nothing to update') {
+      console.error(`[${new Date()}] ${err}`)
+      process.exit(1)
+    }
+  });
+});
+```
+
+Thanks [@aandrulis](https://github.com/aandrulis) for suggesting to expose this.
+
+
 ## Bugs and improvements
 
 If you find a bug or have an idea about how to improve this script you can [open an issue](https://github.com/lmammino/godaddy-dns/issues) or [submit a pull request](https://github.com/lmammino/godaddy-dns/pulls), it will definitely make you a better person! 😝

package.json

@@ -1,6 +1,6 @@
 {
   "name": "godaddy-dns",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A Node.js script to programmatically update GoDaddy DNS records",
   "repository": {
     "type": "git",
@@ -10,6 +10,7 @@
     "type": "MIT",
     "url": "https://raw.githubusercontent.com/lmammino/godaddy-dns/master/LICENSE"
   },
+  "main": "src/godaddy-dns.js",
   "bin": {
     "godaddy-dns": "src/cli.js"
   },

src/__tests__/updateRecords.js

@@ -23,7 +23,7 @@ test('It should update a set of records', endTest => {
         'authorization': `sso-key someKey:someSecret`,
         'content-type': 'application/json'
       },
-      body: {data: ip, type: 'A', name: '@', ttl: 600},
+      body: [ {data: ip, type: 'A', name: '@', ttl: 600} ],
       json: true
     },
     {
@@ -33,7 +33,7 @@ test('It should update a set of records', endTest => {
         'authorization': `sso-key someKey:someSecret`,
         'content-type': 'application/json'
       },
-      body: {data: ip, type: 'A', name: 'subdomain2', ttl: 700},
+      body: [ {data: ip, type: 'A', name: 'subdomain2', ttl: 700} ],
       json: true
     }
   ]
@@ -69,7 +69,7 @@ test('It should update a single record', endTest => {
       'authorization': `sso-key someKey:someSecret`,
       'content-type': 'application/json'
     },
-    body: {data: ip, type: 'A', name: '@', ttl: 600},
+    body: [ {data: ip, type: 'A', name: '@', ttl: 600} ],
     json: true
   }
 

src/godaddy-dns.js

@@ -0,0 +1,7 @@
+const getCurrentIp = require('./getCurrentIp')
+const updateRecords = require('./updateRecords')
+
+module.exports = {
+  getCurrentIp,
+  updateRecords
+}

src/updateRecords.js

@@ -14,6 +14,7 @@ module.exports = function updateRecords (ip, config) {
   }
   records = records.map((record) => {
     // if current record is a single string
+    // wrap it in array
     if (typeof record === 'string') {
       record = {name: record}
     }
@@ -34,7 +35,7 @@ module.exports = function updateRecords (ip, config) {
           'authorization': `sso-key ${config.apiKey}:${config.secret}`,
           'content-type': 'application/json'
         },
-        body: record,
+        body: [ record ],
         json: true
       }
       return request(options)