Add handling for PR as a US state in terminal locations API

[deepakpathania]

Fixes #4061
Similar to: Automattic/woocommerce-payments#10349

Changes proposed in this Pull Request:

• Return PR as a state and US as the country in case PR is set as the country for the terminal locations endpoint.

Testing instructions

• Tests should pass.
• Get location API should return PR as state and US as country in case PR is the location.

---

• Covered with tests (or have a good reason not to test in description ☝️)
• Tested on mobile (or does not apply)

Changelog entry

• This Pull Request does not require a changelog entry. (Comment required below)

Changelog Entry Comment

Comment

Post merge

• Added testing instructions to the Release Testing Instructions wiki page (or does not apply)
• Added the needs docs label (or does not apply)
• Included this PR in the Release Thread scope (or does not apply)

[ricardo]

Get location API should return PR as state and US as country in case PR is the location.

I'm not very familiar with Stripe terminal, so I'd like to learn more about how to test the PR properly before leaving a review.

I followed the testing instructions from #2144 and installed Basic Auth. Here are the results:

curl --user admin:admin \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "PR Test Location",
    "address": {
      "line1": "123 Main St",
      "city": "San Juan",
      "postal_code": "00901",
      "country": "PR"
    }
  }' \
  http://localhost:8072/wp-json/wc/v3/wc_stripe/terminal/locations

⚠️ Immediate response from creating a new location doesn't return a transformed address, not sure if this would be an issue:

{"id":"tml_F9EpAAFAj6DXV9","object":"terminal.location","address":{"city":"San Juan","country":"PR","line1":"123 Main St","line2":"","postal_code":"00901","state":""},"display_name":"PR Test Location","livemode":false,"metadata":{}}

---

curl --user admin:admin \
  http://localhost:8072/wp-json/wc/v3/wc_stripe/terminal/locations

✅ Locations listed appear to be transformed correctly.

[{"id":"tml_F9EpAAFAj6DXV9","object":"terminal.location","address":{"city":"San Juan","country":"US","line1":"123 Main St","line2":"","postal_code":"00901","state":"PR"},"display_name":"PR Test Location","livemode":false,"metadata":{}}]

---

curl --user admin:admin \
  http://localhost:8072/wp-json/wc/v3/wc_stripe/terminal/locations/tml_F9EpAAFAj6DXV9

✅ Single location appears to be transformed correctly.

{"id":"tml_F9EpAAFAj6DXV9","object":"terminal.location","address":{"city":"San Juan","country":"US","line1":"123 Main St","line2":"","postal_code":"00901","state":"PR"},"display_name":"Updated PR Location","livemode":false,"metadata":{}}

---

As I'll be AFK the next couple of days, I'll reassign the reviewer.

[asumaran]

@deepakpathania it looks like the PR is not fully complete yet. I found the same issue as Ricardo in the wc/v3/wc_stripe/terminal/locations endpoint, where PR is still being returned as a country when it should be returned as a state, with the country set to US.

Additionally, if a PR address is updated with the country correctly set as US and the state as PR, it gets misconfigured, returning the country as PR and leaving the state empty.

Existing address

{
  "id": "tml_F9VZ1g0NhsHBGD",
  "object": "terminal.location",
  "address": {
    "city": "San juan",
    "country": "US",
    "line1": "1 Example St.",
    "line2": "",
    "postal_code": "00907",
    "state": "PR"
  },
  "display_name": "Test Location 1",
  "livemode": false,
  "metadata": {}
}

After updating the address

curl -X POST https://wcstripe.test/wp-json/wc/v3/wc_stripe/terminal/locations/tml_F9VZ1g0NhsHBGD \
    -H "Content-Type: application/json" \
    -d '{
        "line1": "12 Example St.",
        "city": "San juan",
        "country": "PR",
        "postal_code": "00907"
      }' \
    -u ck_foo:cs_bar

{
  "id": "tml_F9VZ1g0NhsHBGD",
  "object": "terminal.location",
  "address": {
    "city": "San juan",
    "country": "PR",
    "line1": "1 Example St.",
    "line2": "",
    "postal_code": "00907",
    "state": ""
  },
  "display_name": "Test Location 1",
  "livemode": false,
  "metadata": {}
}

Notice that the country and state were changed incorrectly.

Please give a look at these issues.

[deepakpathania]

@asumaran I have added handling for the create and update cases as well. Could you check once again? Also would you mind sharing credentials for the testing setup so that I can test out with the curl commands you shared as well? Thanks.

[asumaran]

Also would you mind sharing credentials for the testing setup so that I can test out with the curl commands you shared as well?

@deepakpathania I’m testing on my local site. You can also test the REST API using cURL by generating an API key from WooCommerce > Settings > Advanced > REST API. If you don't have a local setup you could use Jurassic Ninja.

[asumaran]

Thanks for the update @deepakpathania. It seems to be working fine with all endpoints I tested:

POST /wp-json/wc/v3/wc_stripe/terminal/locations
GET /wp-json/wc/v3/wc_stripe/terminal/locations
GET /wp-json/wc/v3/wc_stripe/terminal/locations/tml_abcxyz
DELETE /wp-json/wc/v3/wc_stripe/terminal/locations/tml_abcxyz
POST /wp-json/wc/v3/wc_stripe/terminal/locations/tml_abcxyz
GET /wp-json/wc/v3/wc_stripe/terminal/locations/store

[deepakpathania]

Waiting for @iamgabrielma to test before merging.