Feature/add method handling expansion child objects #1063

alan-ms · 2022-03-24T12:50:23Z

Description:

It addresses the problem when we want to expand child objects in jbuilder.

Closes #962
Co-authored-by: MaiconMares [email protected]

Motivation for implementing it:

At the moment we don't have a way to expand child objects in jbuilder, so we implemented an approach where this is possible.

Solution summary:

Modified json partial d transaction, adding expansion of child objects.

  "id": "1",
  "object": "transaction",
  "created": 1648087371,
  "supporter": {
    "id": 1,
    "name": null,
    "organization": null,
    "phone": null,
    "anonymous": false,
    "deleted": false,
    "object": "supporter",
    "merged_into": null,
    "supporter_addresses": [
      1
    ],
    "url": "http://localhost:3000/api/nonprofits/1/supporters/1",
    "nonprofit": 1
  },
  "nonprofit": 1,
  "amount": {
    "cents": 10,
    "currency": "usd"
  },
  "subtransaction": {
    "type": "subtransaction",
    "supporter": 1,
    "nonprofit": 1,
    "transaction": "1",
    "payments": [
      {
        "type": "payment",
        "id": "1",
        "supporter": 1,
        "nonprofit": 1,
        "transaction": "1",
        "subtransaction": {
          "id": "1",
          "object": "offline_transaction",
          "type": "subtransaction"
        },
        "object": "offline_transaction_charge",
        "net_amount": {
          "cents": 100,
          "currency": "usd"
        },
        "gross_amount": {
          "cents": 100,
          "currency": "usd"
        },
        "fee_total": {
          "cents": 100,
          "currency": "usd"
        },
        "created": 0,
        "url": "http://localhost:3000/api/nonprofits/1/transactions/1/subtransaction/payments/1"
      }
    ],
    "url": "http://localhost:3000/api/nonprofits/1/transactions/1/subtransaction",
    "object": "offline_transaction",
    "created": 1648087371,
    "amount": {
      "cents": 100,
      "currency": "usd"
    },
    "net_amount": {
      "cents": 100,
      "currency": "usd"
    }
  },
  "transaction_assignments": [
    {
      "type": "trx_assignment",
      "id": "1",
      "supporter": 1,
      "nonprofit": 1,
      "transaction": "1",
      "object": "donation",
      "designation": null,
      "amount": {
        "cents": 100,
        "currency": "usd"
      }
    }
  ],
  "url": "http://localhost:3000/api/nonprofits/1/transactions/1"
}```

Co-authored-by: MaiconMares <[email protected]>

MaiconMares · 2022-03-24T18:59:34Z

@wwahammy can you review our Pull Request and give feedbacks or guidances on what we need to improve/fix?

wwahammy

Thanks for the work.

I think it'd be helpful to step back for a second and consider what the problem you're trying to solve is. How do all of the changes you've made help you do the following:

Add support for handling the expansion of child objects and
Prove that support works as expected.

A lot of these files here don't actually assist in that effort and therefore, they shouldn't be included. I believe there is testing around simple objects and that expansions work correctly in the source tree in CommitChange. I would recommend starting with that for your testing.

To be clear, you don't need to even use the new expansion code for all of the endpoints in this PR. In fact, it'd probably be better if you didn't!

wwahammy · 2022-03-24T21:35:40Z

.../api/stripe_transaction_dispute_reversals/_stripe_transaction_dispute_reversal.json.jbuilder

+# frozen_string_literal: true
+
+# License: AGPL-3.0-or-later WITH WTO-AP-3.0-or-later
+# Full license explanation at https://github.com/houdiniproject/houdini/blob/main/LICENSE
+
+json.object 'stripe_transaction_dispute_reversal'
+
+json.net_amount do
+	json.partial! '/api_new/common/amount', amount: paymentable.net_amount_as_money
+end
+
+json.gross_amount do
+	json.partial! '/api_new/common/amount', amount: paymentable.gross_amount_as_money
+end
+
+json.fee_total do
+	json.partial! '/api_new/common/amount', amount: paymentable.fee_total_as_money
+end
