Nir's actionnetwork changes

[NirTatcher]

Added some get functions for ActionNetwork module, I have more functions to add (create and update functions) once this batch is approved.
Please let me know if it looks ok :)

[shaunagm]

Hi @NirTatcher sorry it's taking so long to get to this. I plan to review next week! I also ran the tests (which Github was waiting on approval for).

[NirTatcher]

Hi @shaunagm, the PR didn't pass the linting tests, I fixed it (it should now pass the linting tests), updated the branch by the latest commit in main branch.
Thank you!
PS: The PR should also resolve issue #905

[shaunagm]

Can you explain what's going on here? I want to make sure this isn't a breaking change.

[NirTatcher]

Sure @shaunagm!

So in AN we can try getting a resource list by the object/resource name for example:
object_name = "donations"
and using
response_list = response["_embedded"][f"osdi:{object_name}"]
will work and will result with something like this with all of the donations associated with the API key you have:

{
  "total_pages": 1,
  "per_page": 25,
  "page": 1,
  "total_records": 6,
  "_links": {
    "self": {
      "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f/donations"
    },
    "osdi:donations": [
      {
        "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f/donations/f1119c4e-b8ca-44ff-bfa7-f78f7ca3ec16"
      },
      {
        "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f/donations/d86538c1-e8f7-46e1-8320-552da81bd48d"
      },
      //truncated for brevity
    ],
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      },
      {
        "name": "action_network",
        "href": "https://actionnetwork.org/docs/v2/{rel}",
        "templated": true
      }
    ]
  },
  "_embedded": {
    "osdi:donations": [
      {
        "identifiers": [
          "action_network:f1119c4e-b8ca-44ff-bfa7-f78f7ca3ec16"
        ],
        "created_date": "2014-03-27T17:42:21Z",
        "modified_date": "2014-03-27T17:42:24Z",
        "currency": "USD",
        "amount": "20.01",
        "recipients": [
          {
            "display_name": "John Doe",
            "amount": "6.67"
          },
          {
            "display_name": "Progressive Action Now",
            "amount": "6.67"
          },
          {
            "display_name": "Jane Black",
            "amount": "6.67"
          }
        ],
        "payment": {
          "method": "Credit Card",
          "reference_number": "f1119c4e-b8ca-44ff-bfa7-f78f7ca3ec16",
          "authorization_stored": false
        },
        "action_network:recurrence": {
          "recurring": true,
          "period": "Monthly"
        },
        "action_network:person_id": "c945d6fe-929e-11e3-a2e9-12313d316c29",
        "action_network:fundraising_page_id": "049e9bda-cb79-420d-91ba-92e5a15ba62f",
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f/donations/f1119c4e-b8ca-44ff-bfa7-f78f7ca3ec16"
          },
          "osdi:fundraising_page": {
            "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f"
          },
          "osdi:person": {
            "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
          }
        }
      },
      {
        "identifiers": [
          "action_network:d86538c1-e8f7-46e1-8320-552da81bd48d"
        ],
        "created_date": "2014-03-27T17:40:56Z",
        "modified_date": "2014-03-27T17:41:11Z",
        "currency": "USD",
        "amount": "20.00",
        "recipients": [
          {
            "display_name": "John Doe",
            "amount": "10.00"
          },
          {
            "display_name": "Progressive Action Now",
            "amount": "10.00"
          }
        ],
        "payment": {
          "method": "Credit Card",
          "reference_number": "d86538c1-e8f7-46e1-8320-552da81bd48d",
          "authorization_stored": false
        },
        "action_network:recurrence": {
          "recurring": false
        },
        "action_network:person_id": "c945d6fe-929e-11e3-a2e9-12313d316c29",
        "action_network:fundraising_page_id": "049e9bda-cb79-420d-91ba-92e5a15ba62f",
        "_links": {
          "self": {
            "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f/donations/d86538c1-e8f7-46e1-8320-552da81bd48d"
          },
          "osdi:fundraising_page": {
            "href": "https://actionnetwork.org/api/v2/fundraising_pages/049e9bda-cb79-420d-91ba-92e5a15ba62f"
          },
          "osdi:person": {
            "href": "https://actionnetwork.org/api/v2/people/c945d6fe-929e-11e3-a2e9-12313d316c29"
          }
        }
      },
      //truncated for brevity
    ]
  }
} 

You would see that every time we try to get a list of resources/entries the response has the same structure (see key names):

"total_pages":1,
"per_page": 25,
 "page": 1,
 "total_records": 19,
"links":{}
"_embedded":{}
}

The most important this for us here is the _embedded key which contains a json with one key value pair, the key name is "osdi:{object_name}" ("osdi:donations") and will contain an array with all of the current page donations.

Sometimes we would like to get more specific when trying to get a resource list like for example if we want to get all donations for a specific fundraising_page (all donations associated with a specific fundraising_page) we would need to reach a structured "object_name":
object_name = "fundraising_page/[fundraising_id]/donations"

using response_list = response["_embedded"][f"osdi:{object_name}"]
will result with an error because we would try to extract the value of "osdi:fundraising_page/[fundraising_id]/donations" instead of "osdi:donations".

We can solve that issue by using list(response["_embedded"])[0] which is the equivalent of Object.keys(object)[0] in JS and results with the first key name in the _embedded json (we know that we only have one key value pair in _embedded) and by that when trying to get a structured resource like "osdi:fundraising_page/[fundraising_id]/donations" we would try to extract "osdi:donations" instead of "osdi:fundraising_page/[fundraising_id]/donations".

I think it's a better solution for that function because it gives us more flexibility and the key name is not half hard coded + it would not cause an issue when trying to get a structured resource.

I hope I explained myself properly.
Thank you and please let me know if there is any other question regarding this :)

[shaunagm]

Thank you for the explanation! Super helpful. So it sounds like this will not break any existing code, because only object_names like "donations" was working anyway, and your approach still works for them. This just expands the valid object_names. And I didn't realize this before, but object_name really only seems to be used internally, and is not exposed to the end-user, so that makes worrying about breaking changes way less important anyway. :)

[shaunagm]

You've added a number of methods with no test coverage. I realize that having test coverage is of relatively marginal value given that we have to mock the endpoints, and I don't want to create a ton of busywork for you, but I would love it if we could check that the call is what we expect, given the parameters input.

[NirTatcher]

Hi @shaunagm,
I reorganized the code and added tests for all functions added by me.
Please let me know if it looks ok to you.

[shaunagm]

These look great! Thank you for adding all these tests, Nir.

[shaunagm]

Overall this looks great, had one quick question and a request about test coverage. Sorry for the delay in reviewing.

[NirTatcher]

Overall this looks great, had one quick question and a request about test coverage. Sorry for the delay in reviewing.

Hi @shaunagm,

I reorganized the code and added tests for every function. Everything should be working fine now please let me know how it looks like to you.

[shaunagm]

These look great. Thanks so much for adding all these methods, @NirTatcher!

[shaunagm]

Merged! Thank you so much @NirTatcher