Merge pull request #59 from Permissionless-Software-Foundation/ct-unstable

fix(price): Removing documentation for deprecated endpoint

package.json

@@ -16,7 +16,7 @@
     "test:integration:local": "RESTURL=http://localhost:3000/v3/ mocha --timeout 30000 test/integration",
     "test:integration:local:bchn": "RESTURL=http://localhost:3000/v3/ bash test/integration/test-free-tier-bchn.sh",
     "test:integration:local:testnet": "RESTURL=http://localhost:4000/v3/ mocha --timeout 30000 test/integration/testnet",
-    "test:temp": "mocha --timeout 30000 -g '#Encryption' test/integration/",
+    "test:temp": "RESTURL=http://localhost:3000/v3/ mocha --timeout 30000 -g '#price' test/integration/",
     "test:integration:api": "RESTURL=https://api.fullstack.cash/v3/ mocha --timeout 30000 test/integration",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",

src/price.js

@@ -29,26 +29,7 @@ class Price {
     this.axios = axios
   }
 
-  /**
-   * @api price.current() current()
-   * @apiName Price.
-   * @apiGroup Price
-   * @apiDescription Return current price of BCH in multiple currencies.
-   * This endpoint will be deprecated in favor of getUSD. It uses the Bitcoin.com
-   * price feed.
-   *
-   * @apiExample Example usage:
-   *(async () => {
-   *  try {
-   *    let current = await bchjs.Price.current('usd');
-   *    console.log(current);
-   *  } catch(err) {
-   *   console.err(err)
-   *  }
-   *})()
-   *
-   * // 26681
-   */
+  // This endpoint is deprecated. Documentation removed.
   async current(currency = "usd") {
     try {
       const response = await this.axios.get(
@@ -140,6 +121,41 @@ class Price {
       else throw err
     }
   }
+
+  /**
+   * @api price.getBchaUsd() getBchaUsd()
+   * @apiName Price getBchaUsd()
+   * @apiGroup Price
+   * @apiDescription Return current price of BCHA in USD.
+   * This endpoint gets the USD price of BCHA from the Coinex API. The price
+   * comes from bch-api, so it has a better chance of working in Tor.
+   *
+   * @apiExample Example usage:
+   *(async () => {
+   *  try {
+   *    let current = await bchjs.Price.getBchaUsd();
+   *    console.log(current);
+   *  } catch(err) {
+   *   console.err(err)
+   *  }
+   *})()
+   *
+   * // 18.81
+   */
+  async getBchaUsd() {
+    try {
+      const response = await this.axios.get(
+        `${this.restURL}price/bchausd`,
+        _this.axiosOptions
+      )
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      return response.data.usd
+    } catch (err) {
+      if (err.response && err.response.data) throw err.response.data
+      else throw err
+    }
+  }
 }
 
 module.exports = Price

test/integration/bchn/price.js

@@ -21,6 +21,15 @@ describe("#price", () => {
     })
   })
 
+  describe("#getBchaUsd", () => {
+    it("should get the USD price of BCHA", async () => {
+      const result = await bchjs.Price.getBchaUsd()
+      console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
+
   describe("#rates", () => {
     it("should get the price of BCH in several currencies", async () => {
       const result = await bchjs.Price.rates()

test/integration/price.js

@@ -25,6 +25,15 @@ describe("#price", () => {
     })
   })
 
+  describe("#getBchaUsd", () => {
+    it("should get the USD price of BCHA", async () => {
+      const result = await bchjs.Price.getBchaUsd()
+      console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
+
   describe("#rates", () => {
     it("should get the price of BCH in several currencies", async () => {
       const result = await bchjs.Price.rates()

test/unit/price.js

@@ -5,7 +5,7 @@ const sinon = require("sinon")
 const mockDataLib = require("./fixtures/price-mocks")
 let mockData
 
-describe("#Price", () => {
+describe("#price", () => {
   let sandbox
   let bchjs
 
@@ -56,4 +56,15 @@ describe("#Price", () => {
       assert.property(result, "CAD")
     })
   })
+
+  describe("#getBchaUsd", () => {
+    it("should get the USD price of BCHA", async () => {
+      sandbox.stub(bchjs.Price.axios, "get").resolves({ data: { usd: 18.87 } })
+
+      const result = await bchjs.Price.getBchaUsd()
+      // console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
 })