Retrieve me (#158)

* Add RetrieveMe Convenience Functions

* Update CHANGELOG.md

Co-authored-by: Justin Hammond <[email protected]>

Co-authored-by: Justin Hammond <[email protected]>

Author: jchen293

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Removes `_max_timeout` and instead uses a flat 60 second timeout for requests
 * Adds Python version to user-agent header on requests
 * Removes `shipment.get_rates()` method since the shipment object already has rates. If you need to get new rates for a shipment, please use the `shipment.regenerate_rates()` method.
+* Add `retrieve_me()` convenience function that allow users to retrieve without specifying an ID.
 
 ### v6.0.0 2021-10-12
 

easypost/__init__.py

@@ -867,6 +867,12 @@ def retrieve(cls, easypost_id="", api_key=None, **params):
             instance.refresh()
             return instance
 
+    @classmethod
+    def retrieve_me(cls, api_key=None, **params):
+        requestor = Requestor(api_key)
+        response, api_key = requestor.request("get", cls.class_url())
+        return convert_to_easypost_object(response, api_key)
+
     @classmethod
     def all_api_keys(cls, api_key=None):
         requestor = Requestor(api_key)

tests/cassettes/test_retrieve_me.yaml

@@ -0,0 +1,81 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-type:
+      - application/json
+      authorization:
+      - EZTK-NONE
+      user-agent:
+      - easypost/v2 pythonclient/suppressed
+      x-client-user-agent:
+      - suppressed
+    method: GET
+    uri: https://api.easypost.com/v2/users
+  response:
+    body:
+      string: !!binary |
+        H4sIAAAAAAAAA9STy27bMBBFf8XQtlYwfItatSi66yILd5MiEPgYRSr0MCgpQBDk3ztyUjdOELdb
+        c0deDnkP5/Ixa2NWZsuEqVJSKO20tzpYCbGwTFjNnAjGW7A1z7bZ6H9hmKngBxXQfO8SDnO1njEs
+        XbfNBtcjyd/c9HA9TvPm+mFuxmHztWtp3+Z765NLD5sdTvO0lpOG1bD0nk4rM3UcpN1jausW6eQ5
+        LbjNQkI3Y6zcej0HZnIQObAdiBJYKeQN1XjXuSGsBuAK1rHekdqA1Z74pqbd92TjRE4YGpfusHL9
+        uKzaM8eEYRwiea0+2HBcnpuEUzN2xydo3FT5tuva4a7qkfCPSghVjVgl4nj2IMhAxNotHb3hMC1p
+        df/mor/rp7Use6v17dD2S08yuzqwYe/ajqYR7z8hdWRPHcn3h458/jO/CmNPW0PTdpF6mZU/H19F
+        wvrAlWMRTK2kLri1hkJihfECoqzhfCT+O1YvqXkJy5euy3cNPd+Ur0GhCLxLSgFAKQF2wPxHUjjk
+        oHLGdpyVypZgbk55b5+2r5GFdsKqIkStnFSWexajN5LXJgqhubsgZLl+DqVKxc8j10oxU3gQPEgZ
+        DBaBa8ZqV0jJVLTyspBlSdRcnEdGVhfgOIKqCymYtRqCFgbIMaDBiwm2yTnfMVYyW0p1HlmjRLTK
+        as+MDCy4KGRBv5i+NnCD9QUhmx1AyYtS2nfIt0+/AQAA//8DACIHgfPTBgAA
+    headers:
+      cache-control:
+      - no-cache, no-store
+      content-encoding:
+      - gzip
+      content-type:
+      - application/json; charset=utf-8
+      etag:
+      - W/"34ca08bedadc1e53373fe4563b1c2ca3"
+      expires:
+      - '0'
+      pragma:
+      - no-cache
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+      transfer-encoding:
+      - chunked
+      x-backend:
+      - easypost
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-ep-request-uuid:
+      - 704d1f6d6217f664ff22b938004b019a
+      x-frame-options:
+      - SAMEORIGIN
+      x-node:
+      - bigweb9nuq
+      x-permitted-cross-domain-policies:
+      - none
+      x-proxied:
+      - intlb1nuq 88c34981dc
+      - extlb2nuq 88c34981dc
+      x-request-id:
+      - 5148adca-8a43-46f0-865a-636b9d39e833
+      x-runtime:
+      - '0.093758'
+      x-version-label:
+      - easypost-202202242013-00973e8608-master
+      x-xss-protection:
+      - 1; mode=block
+    status:
+      code: 200
+      message: OK
+version: 1

tests/test_user.py

@@ -5,6 +5,13 @@
 import easypost
 
 
+@pytest.mark.vcr()
+def test_retrieve_me(prod_api_key):
+    user = easypost.User.retrieve_me()
+
+    assert user.id is not None
+
+
 @pytest.mark.vcr()
 def test_child_user_create(prod_api_key):
     # Create an address and then verify some fields to test whether it was created just fine.