service2service 2.2.0 → 2.3.0

package/README.md

@@ -34,24 +34,23 @@ agent.generate()
     // token is verified, error gets thrown if not verified
   })
 
-// This is an instance of request promise that will automatically add the
+// This is a wrapper around axios that will automatically add the
 // header to every request. This takes care of the `generate` functionality for
 // you.
 
-// Note that this is just a wrapper around request promise because we have to
+// Note that this is just a wrapper around axios because we have to
 // handle the case of asynchronous secret getting. If you wish to use the raw
-// request object, implement the `generate()` method into your workflow
+// axios object, implement the `generate()` method into your workflow
 agent
   .request({
-    uri: 'http://www.example.com',
-    method: 'POST'
-    body: {
+    url: 'http://www.example.com',
+    method: 'POST',
+    data: {
       some: 'payload'
-    },
-    resolveWithFullResponse: true,
-    json: true
+    }
   })
-  .then(({ body, statusCode }) => {
+  .then((response) => {
+    // response is the response body (axios automatically parses JSON)
     // Successful request!
   })
 ```
@@ -179,15 +178,37 @@ parameter is optional and is only used if you want to override the agent's
 
 ## `agent.request(reqOptions[, genOptions [, payload])`
 
-This is wrapper around [`request-promise`][request]. It accepts all the same
-options. Note that this is just a wrapper function and does not provide the
-sugar methods like `request.post()` or `request.get()`.
+This is a wrapper around [`axios`][axios]. It accepts axios-compatible options.
+Note that this is just a wrapper function and does not provide the
+sugar methods like `axios.post()` or `axios.get()`.
+
+- `reqOptions` {Object} - The options you pass into axios. You can see all
+  of the available options [`here`][axios]. Common options:
+  - `url` {string} - The URL to request
+  - `method` {string} - HTTP method (GET, POST, etc.)
+  - `data` {Object|string} - Request body
+  - `headers` {Object} - Custom headers
+  - `params` {Object} - URL query parameters
+
+  **Backward compatibility:** For compatibility with `request-promise`, the
+  following aliases are also supported:
+  - `uri` - Alias for `url`
+  - `body` - Alias for `data`
+  - `qs` - Alias for `params`
 
-- `reqOptions` {Object} - The options you pass into `request`. You can see all
-  of the available options [`here`][request]
 - `genOptions` {Object} - The options that get passed into `agent.generate()`
 - `payload` {Object} - The payload that gets passed into `agent.generate()`
 
+**Return value:** The method returns a promise that resolves to the response
+body (`response.data`), not the full response object.
+
+**Error handling:** HTTP errors (4xx, 5xx) will reject with an error object
+containing:
+- `message` - The response body or error message
+- `statusCode` - The HTTP status code
+- `error` - The response body (for compatibility with request-promise)
+- `response` - The full axios response object (for debugging)
+
 ## middleware
 
 The api for express middleware and koa middleware is the same. It accepts all
@@ -216,4 +237,4 @@ koaMiddleware(agent)
   `agent.verify(token, options)`
 
 [jwt.sign]: https://www.npmjs.com/package/jsonwebtoken#user-content-jwtsignpayload-secretorprivatekey-options-callback
-[request]: https://www.npmjs.com/package/request-promise
+[axios]: https://www.npmjs.com/package/axios

package/helpers/requestOptionsToAxios.js

@@ -0,0 +1,62 @@
+'use strict'
+
+const axios = require('axios')
+
+function mapOption(reqOptions, from, to) {
+  const hasFrom = typeof reqOptions[from] !== 'undefined'
+  const noTo = typeof reqOptions[to] === 'undefined'
+  if (hasFrom && noTo) {
+    reqOptions[to] = reqOptions[from]
+    delete reqOptions[from]
+  }
+}
+
+function requestOptionsToAxios(reqOptions) {
+  if (reqOptions.uri && !reqOptions.url) {
+    reqOptions.url = reqOptions.uri
+    delete reqOptions.uri
+  }
+  mapOption(reqOptions, 'qs', 'params')
+  mapOption(reqOptions, 'body', 'data')
+  delete reqOptions.json
+}
+
+
+function executeAxiosRequest(reqOptions) {
+  const resolveWithFullResponse = reqOptions.resolveWithFullResponse === true
+  const simple = reqOptions.simple !== false
+  if ('resolveWithFullResponse' in reqOptions) {
+    delete reqOptions.resolveWithFullResponse
+  }
+  if ('simple' in reqOptions) delete reqOptions.simple
+
+  requestOptionsToAxios(reqOptions)
+  if (simple === false) {
+    reqOptions.validateStatus = () => true
+  }
+
+  return axios(reqOptions)
+    .then((response) => {
+      if (resolveWithFullResponse) {
+        return {
+          statusCode: response.status,
+          headers: response.headers,
+          body: response.data
+        }
+      }
+      return response.data
+    })
+    .catch((error) => {
+      if (error.response) {
+        const err = new Error(error.response.data || error.message)
+        err.statusCode = error.response.status
+        err.error = error.response.data
+        err.response = error.response
+        return Promise.reject(err)
+      }
+      return Promise.reject(error)
+    })
+}
+
+module.exports = requestOptionsToAxios
+module.exports.executeAxiosRequest = executeAxiosRequest

package/index.js

@@ -1,11 +1,11 @@
 'use strict'
 
 const Promise = require('bluebird')
-const request = require('request-promise')
 const jwt = require('jsonwebtoken')
 const uuid = require('uuid')
 const tryFallbacks = require('./lib/try-fallbacks')
 const Housekeeper = require('./lib/housekeeper')
+const { executeAxiosRequest } = require('./helpers/requestOptionsToAxios')
 
 Promise.promisifyAll(jwt)
 
@@ -87,7 +87,7 @@ class ServiceAgent {
       reqOptions.headers = Object.assign({
         [this.header]: this.tokenPrefix + token
       }, reqOptions.headers)
-      return request(reqOptions)
+      return executeAxiosRequest(reqOptions)
     })
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "service2service",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "A node module to make service to service communication secure and easy",
   "main": "index.js",
   "scripts": {
@@ -13,6 +13,7 @@
   },
   "files": [
     "lib",
+    "helpers",
     "express.js",
     "index.js",
     "koa.js"
@@ -38,10 +39,9 @@
   },
   "homepage": "https://github.com/KualiCo/service2service#readme",
   "dependencies": {
+    "axios": "^0.21.2",
     "bluebird": "^3.5.0",
     "jsonwebtoken": "^8.4.0",
-    "request": "^2.81.0",
-    "request-promise": "^4.2.0",
     "uuid": "^3.0.1"
   },
   "devDependencies": {