Metadata query params for Orders endpoint (#35)

Author: kleinjm

.github/workflows/test.yml

@@ -8,9 +8,12 @@ on:
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
+
     strategy:
       matrix:
         node: ['10', '12', '14', '16']
+      max-parallel: 1
+
     name: Node ${{ matrix.node }} Test
     steps:
       - name: Check out code

.mocharc.yml

@@ -1,2 +1,3 @@
 require: '@babel/register'
 recursive: true
+timeout: '10000'

.nvmrc

@@ -0,0 +1 @@
+10.24.1

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.9.0] - 2021-08-17
+
+### Added
+
+- Add support for querying Orders by `metadata`
+- Added `transaction_value_eth_gwei` as an alternative way to compute transaction level emissions for ethereum
+
 ## [1.8.0] - 2021-07-20
 
 ### Added

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@patch-technology/patch",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "JavaScript wrapper for the Patch API",
   "license": "MIT",
   "repository": {
@@ -21,6 +21,7 @@
     "fs": false
   },
   "dependencies": {
+    "query-string": "^7.0.1",
     "superagent": "^5.3.1"
   },
   "devDependencies": {
@@ -50,9 +51,6 @@
     "mocha": ">=8.1.0",
     "prettier": "^2.0.5"
   },
-  "peerDependencies": {
-    "querystring": "^0.2.0"
-  },
   "files": [
     "dist"
   ],

package.json

@@ -6,7 +6,7 @@
  */
 
 import superagent from 'superagent';
-import querystring from 'querystring';
+import querystring from 'query-string';
 
 class ApiClient {
   constructor() {
@@ -60,6 +60,9 @@ class ApiClient {
     if (param instanceof Date) {
       return param.toJSON();
     }
+    if (param instanceof Object) {
+      return param;
+    }
 
     return param.toString();
   }

src/ApiClient.js

@@ -196,7 +196,13 @@ export default class OrdersApi {
 
     let pathParams = {};
     let queryParams = {
-      page: opts['page']
+      page: opts['page'],
+
+      metadata: opts['metadata'],
+
+      'metadata[example1]': opts['metadataExample1'],
+
+      'metadata[example2]': opts['metadataExample2']
     };
     let headerParams = {};
     let formParams = {};

src/api/OrdersApi.js

@@ -26,6 +26,13 @@ class CreateEthereumEstimateRequest {
         obj['gas_used'] = ApiClient.convertToType(data['gas_used'], 'Number');
       }
 
+      if (data.hasOwnProperty('transaction_value_eth_gwei')) {
+        obj['transaction_value_eth_gwei'] = ApiClient.convertToType(
+          data['transaction_value_eth_gwei'],
+          'Number'
+        );
+      }
+
       if (data.hasOwnProperty('project_id')) {
         obj['project_id'] = ApiClient.convertToType(
           data['project_id'],
@@ -48,6 +55,9 @@ CreateEthereumEstimateRequest.prototype['timestamp'] = undefined;
 
 CreateEthereumEstimateRequest.prototype['gas_used'] = undefined;
 
+CreateEthereumEstimateRequest.prototype['transaction_value_eth_gwei'] =
+  undefined;
+
 CreateEthereumEstimateRequest.prototype['project_id'] = undefined;
 
 CreateEthereumEstimateRequest.prototype['create_order'] = undefined;

src/model/CreateEthereumEstimateRequest.js

@@ -49,4 +49,21 @@ describe('Orders Integration', function () {
     const placeOrderResponse = await patch.orders.cancelOrder(orderId);
     expect(placeOrderResponse.data.state).to.equal('cancelled');
   });
+
+  it('supports creating and querying orders by metadata', async function () {
+    const createOrderResponse = await patch.orders.createOrder({
+      mass_g: 100,
+      metadata: { external_id: 'order-123' }
+    });
+
+    const retrieveOrdersResponse = await patch.orders.retrieveOrders({
+      page: 1,
+      metadata: { external_id: 'order-' }
+    });
+    expect(retrieveOrdersResponse.data.length).to.be.above(0);
+
+    retrieveOrdersResponse.data.forEach((order) => {
+      expect(order.metadata).to.have.all.keys('external_id');
+    });
+  });
 });