chore: Swapping Postman with Bruno (#2422)

* chore: trying out bruno

* chore: fix OP example

* fix: admin API examples

* chore: update backend admin api endpoints

* chore: remove console log

* chore: finish transition to bruno

* chore: add remote environment

* chore: remove postman stuff

* chore: cleanup

* chore: renaming and bugfix

* chore: update docs

* chore: enable prettier on bruno collection

* docs: update

* refactor: rename postman -> bruno

* chore: update ignore files

* fix: path

Co-authored-by: Max Kurapov <[email protected]>

---------

Co-authored-by: Max Kurapov <[email protected]>

Author: sabineschaller

.dockerignore

@@ -17,8 +17,7 @@ Dockerfile
 commitlint.config.js
 jest.config.base.js
 renovate.json
-postman
-.postman
+bruno
 
 **/jest.config.js
 **/jest.setup.js

.eslintignore

@@ -3,6 +3,4 @@ public
 **/generated
 dist
 build
-postman-scripts
-postman
-.postman
+bruno

.github/pull_request_template.md

@@ -28,4 +28,4 @@ Checklist items become clickable check boxes once the pull request is created. T
 - [ ] Tests added/updated
 - [ ] Documentation added
 - [ ] Make sure that all checks pass
-- [ ] Postman collection updated
+- [ ] Bruno collection updated

.github/workflows/postman-publish-main.yml

@@ -14,7 +14,5 @@ build
 **/styles/*.css
 .docusaurus
 .cache-loader
-postman
-.postman
 packages/documentation/src/content/docs/apis
 .astro

.github/workflows/postman-publish-tag.yml

@@ -0,0 +1,67 @@
+meta {
+  name: Create Outgoing Payment
+  type: graphql
+  seq: 3
+}
+
+post {
+  url: {{RafikiGraphqlHost}}/graphql
+  body: graphql
+  auth: none
+}
+
+body:graphql {
+  mutation CreateOutgoingPayment($input: CreateOutgoingPaymentInput!) {
+    createOutgoingPayment(input: $input) {
+      code
+      message
+      payment {
+        createdAt
+        error
+        metadata
+        id
+        walletAddressId
+        receiveAmount {
+          assetCode
+          assetScale
+          value
+        }
+        receiver
+        debitAmount {
+          assetCode
+          assetScale
+          value
+        }
+        sentAmount {
+          assetCode
+          assetScale
+          value
+        }
+        state
+        stateAttempts
+      }
+      success
+    }
+  }
+}
+
+body:graphql:vars {
+  {
+    "input": {
+      "walletAddressId": "{{gfranklinWalletAddressId}}",
+      "quoteId": "{{quoteId}}"
+    }
+  }
+}
+
+script:post-response {
+  const body = res.getBody();
+  
+  bru.setEnvVar("outgoingPaymentId", body.data.createOutgoingPayment.payment.id);
+}
+
+tests {
+  test("Outgoing Payment id is string", function() {
+    expect(bru.getEnvVar("outgoingPaymentId")).to.be.a("string");
+  })
+}

.github/workflows/postman-publish.yml

@@ -0,0 +1,68 @@
+meta {
+  name: Create Quote
+  type: graphql
+  seq: 2
+}
+
+post {
+  url: {{RafikiGraphqlHost}}/graphql
+  body: graphql
+  auth: none
+}
+
+body:graphql {
+  mutation CreateQuote($input: CreateQuoteInput!) {
+    createQuote(input: $input) {
+      code
+      message
+      quote {
+        createdAt
+        expiresAt
+        highEstimatedExchangeRate
+        id
+        lowEstimatedExchangeRate
+        maxPacketAmount
+        minExchangeRate
+        walletAddressId
+        receiveAmount {
+          assetCode
+          assetScale
+          value
+        }
+        receiver
+        debitAmount {
+          assetCode
+          assetScale
+          value
+        }
+      }
+    }
+  }
+}
+
+body:graphql:vars {
+  {
+    "input": {
+      "walletAddressId": "{{gfranklinWalletAddressId}}",
+      "receiver": "{{receiverId}}"
+    }
+  }
+}
+
+script:pre-request {
+  const scripts = require('./scripts/scripts');
+  
+  await scripts.getWalletAddressId('RafikiGraphqlHost', 'Grace Franklin', 'gfranklinWalletAddressId');
+}
+
+script:post-response {
+  const body = res.getBody();
+  
+  bru.setEnvVar("quoteId", body.data.createQuote.quote.id);
+}
+
+tests {
+  test("Quote id is string", function() {
+    expect(bru.getEnvVar("quoteId")).to.be.a("string");
+  })
+}

.postman/api

@@ -0,0 +1,68 @@
+meta {
+  name: Create Receiver (remote Incoming Payment)
+  type: graphql
+  seq: 1
+}
+
+post {
+  url: {{RafikiGraphqlHost}}/graphql
+  body: graphql
+  auth: none
+}
+
+body:graphql {
+  mutation CreateReceiver($input: CreateReceiverInput!) {
+    createReceiver(input: $input) {
+      code
+      message
+      receiver {
+        completed
+        createdAt
+        expiresAt
+        metadata
+        id
+        incomingAmount {
+          assetCode
+          assetScale
+          value
+        }
+        walletAddressUrl
+        receivedAmount {
+          assetCode
+          assetScale
+          value
+        }
+        updatedAt
+      }
+      success
+    }
+  }
+}
+
+body:graphql:vars {
+  {
+    "input": {
+      "metadata": {
+          "description": "cross-currency"
+      },
+      "incomingAmount": {
+        "assetCode": "EUR",
+        "assetScale": 2,
+        "value": 500
+      },
+      "walletAddressUrl": "https://happy-life-bank-backend/accounts/lars"
+    }
+  }
+}
+
+script:post-response {
+  const body = res.getBody();
+  
+  bru.setEnvVar("receiverId", body.data.createReceiver.receiver.id);
+}
+
+tests {
+  test("Receiver id is string", function() {
+    expect(bru.getEnvVar("receiverId")).to.be.a("string");
+  })
+}

.postman/api_84fc90ca-3153-4865-8b49-b91218e5d574

@@ -0,0 +1,50 @@
+meta {
+  name: Get Outgoing Payment
+  type: graphql
+  seq: 4
+}
+
+post {
+  url: {{RafikiGraphqlHost}}/graphql
+  body: graphql
+  auth: none
+}
+
+body:graphql {
+  query GetOutgoingPayment($id: String!) {
+  outgoingPayment(id: $id) {
+      createdAt
+      error
+      metadata
+      id
+      walletAddressId
+      quote {
+        id
+      }
+      receiveAmount {
+        assetCode
+        assetScale
+        value
+      }
+      receiver
+      debitAmount {
+        assetCode
+        assetScale
+        value
+      }
+      sentAmount {
+        assetCode
+        assetScale
+        value
+      }
+      state
+      stateAttempts
+    }
+  }
+}
+
+body:graphql:vars {
+  {
+      "id": "{{outgoingPaymentId}}"
+  }
+}