test(address): Method getMetrics add tests + docs

Author: taylorjdawson

dist/web3data.min.js

@@ -2508,12 +2508,17 @@
       }).then(onFulfilled$1, onError$1)
     }
 
-    // TODO: Needs tests
-    getMetrics(filterOptions) {
+    /**
+     * Get metrics for all addresses that have exist publicly for a given blockchain. Default metrics are for Ethereum over a 24h period.
+     *
+     * @returns The address metrics.
+     * @example
+     * const metrics = await web3data.address.getMetrics(ADDRESS)
+     */
+    getMetrics() {
       return get$1(this.web3data, {
         endpoint: ENDPOINT,
-        subendpoint: 'metrics/latest',
-        filterOptions
+        subendpoint: 'metrics/latest'
       }).then(onFulfilled$1, onError$1)
     }
   }

docs/api.md

@@ -635,6 +635,32 @@ const usage = await web3data.address.getUsage(ADDRESS)
 
 
 
+#### getMetrics()
+
+
+Get metrics for all addresses that have exist publicly for a given blockchain. Default metrics are for Ethereum over a 24h period.
+
+
+
+
+
+
+##### Examples
+
+```javascript
+const metrics = await web3data.address.getMetrics(ADDRESS)
+```
+
+
+##### Returns
+
+
+-  The address metrics.
+
+
+
+
+
 ### src/block.js
 
 

src/address.js

@@ -354,12 +354,17 @@ Returns null if no address is found.
     }).then(onFulfilled, onError)
   }
 
-  // TODO: Needs tests
-  getMetrics(filterOptions) {
+  /**
+   * Get metrics for all addresses that have exist publicly for a given blockchain. Default metrics are for Ethereum over a 24h period.
+   *
+   * @returns The address metrics.
+   * @example
+   * const metrics = await web3data.address.getMetrics(ADDRESS)
+   */
+  getMetrics() {
     return get(this.web3data, {
       endpoint: ENDPOINT,
-      subendpoint: 'metrics/latest',
-      filterOptions
+      subendpoint: 'metrics/latest'
     }).then(onFulfilled, onError)
   }
 }

test/address.test.js

@@ -411,3 +411,9 @@ test('Successfully gets historical address balance + paginates properly', async
     const balance = await t.context.web3data.address.getBalance(ADDRESS, {startDate: 1506184430, page: 0, size: SIZE})
     t.is(balance.data.length, SIZE)
 })
+
+/*********** Test getMetrics() ***********/
+test('Successfully calls getMetrics()', async t => {
+    const metrics = await t.context.web3data.address.getMetrics(ADDRESS)
+    t.true(metrics.hasProp('activeTotal'))
+})

test/recordings/address_745154899/recording.har

@@ -5645,6 +5645,143 @@
           "ssl": -1,
           "wait": 8871
         }
+      },
+      {
+        "_id": "e1f374bf9423c8263c7cfd0cdcaaf4b1",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "name": "accept",
+              "value": "application/json, text/plain, */*"
+            },
+            {
+              "name": "user-agent",
+              "value": "axios/0.19.0"
+            },
+            {
+              "name": "host",
+              "value": "web3api.io"
+            }
+          ],
+          "headersSize": 202,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [],
+          "url": "https://web3api.io/api/v2/addresses/metrics/latest?x-api-key="
+        },
+        "response": {
+          "bodySize": 134,
+          "content": {
+            "mimeType": "application/json; charset=utf-8",
+            "size": 134,
+            "text": "{\"status\":200,\"title\":\"OK\",\"description\":\"Successful request\",\"payload\":{\"activeTotal\":\"264780\",\"activeAverage\":\"11032.500000000000\"}}"
+          },
+          "cookies": [
+            {
+              "expires": "2019-11-07T22:08:12.000Z",
+              "name": "AWSALB",
+              "path": "/",
+              "value": "ZhcDnXPuJeoqPtdayNQCVkuk5JGsocmKwvMZkwtIDjEVi99xa3Jku+Zt1ERa2tkMqNWGHu3XCrXWbGfFpbuVNYQZDrlDLwmgmHfRteZFay8WpVDquOM4K30CwEFz"
+            }
+          ],
+          "headers": [
+            {
+              "name": "hasprop"
+            },
+            {
+              "name": "values"
+            },
+            {
+              "name": "content-type",
+              "value": "application/json; charset=utf-8"
+            },
+            {
+              "name": "content-length",
+              "value": "134"
+            },
+            {
+              "name": "connection",
+              "value": "close"
+            },
+            {
+              "name": "date",
+              "value": "Thu, 31 Oct 2019 22:08:12 GMT"
+            },
+            {
+              "name": "x-amzn-requestid",
+              "value": "6321b92f-65f3-415c-9ad7-af31033c766f"
+            },
+            {
+              "name": "access-control-allow-origin",
+              "value": "*"
+            },
+            {
+              "name": "x-response-time",
+              "value": "52.973ms"
+            },
+            {
+              "name": "x-amzn-remapped-content-length",
+              "value": "134"
+            },
+            {
+              "name": "x-amzn-remapped-connection",
+              "value": "keep-alive"
+            },
+            {
+              "_fromType": "array",
+              "name": "set-cookie",
+              "value": "AWSALB=ZhcDnXPuJeoqPtdayNQCVkuk5JGsocmKwvMZkwtIDjEVi99xa3Jku+Zt1ERa2tkMqNWGHu3XCrXWbGfFpbuVNYQZDrlDLwmgmHfRteZFay8WpVDquOM4K30CwEFz; Expires=Thu, 07 Nov 2019 22:08:12 GMT; Path=/"
+            },
+            {
+              "name": "x-amz-apigw-id",
+              "value": "Ccsz9GemIAMF5ew="
+            },
+            {
+              "name": "etag",
+              "value": "W/\"86-lcssCvRUZ6KvQ5iZkswDv0U0IHg\""
+            },
+            {
+              "name": "x-amzn-remapped-date",
+              "value": "Thu, 31 Oct 2019 22:08:12 GMT"
+            },
+            {
+              "name": "x-cache",
+              "value": "Miss from cloudfront"
+            },
+            {
+              "name": "via",
+              "value": "1.1 5ab5dc09da67e3ea794ec8a82992cc89.cloudfront.net (CloudFront)"
+            },
+            {
+              "name": "x-amz-cf-pop",
+              "value": "HIO50-C1"
+            },
+            {
+              "name": "x-amz-cf-id",
+              "value": "owFRnbI3_gogSz9v_3wW0r_0LZhLWnRrcoia1f9mjX0l1Vl-7y4cew=="
+            }
+          ],
+          "headersSize": 1050,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2019-10-31T22:08:12.120Z",
+        "time": 536,
+        "timings": {
+          "blocked": -1,
+          "connect": -1,
+          "dns": -1,
+          "receive": 0,
+          "send": 0,
+          "ssl": -1,
+          "wait": 536
+        }
       }
     ],
     "pages": [],