Merge pull request #102 from MerleLiuKun/feat-me

Feat me

Author: MerleLiuKun

pytwitter/api.py

@@ -1234,6 +1234,40 @@ def get_user(
             return_json=return_json,
         )
 
+    def get_me(
+        self,
+        *,
+        user_fields: Optional[Union[str, List, Tuple]] = None,
+        expansions: Optional[Union[str, List, Tuple]] = None,
+        tweet_fields: Optional[Union[str, List, Tuple]] = None,
+        return_json: bool = False,
+    ):
+        """
+        Returns information about an authorized user.
+
+        :param user_fields: Fields for the user object.
+        :param expansions: Fields for expansions.
+        :param tweet_fields: Fields for the tweet object.
+        :param return_json: Type for returned data. If you set True JSON data will be returned.
+        :returns:
+            - data: data for the user
+            - includes: expansions data.
+        """
+        args = {
+            "user.fields": enf_comma_separated(name="user_fields", value=user_fields),
+            "tweet.fields": enf_comma_separated(
+                name="tweet_fields", value=tweet_fields
+            ),
+            "expansions": enf_comma_separated(name="expansions", value=expansions),
+        }
+
+        return self._get(
+            url=f"{self.BASE_URL_V2}/users/me",
+            params=args,
+            cls=md.User,
+            return_json=return_json,
+        )
+
     def get_following(
         self,
         user_id: str,

testdata/apis/user/me_resp.json

@@ -0,0 +1 @@
+{"data":{"name":"Twitter Dev","username":"TwitterDev","pinned_tweet_id":"1460323737035677698","created_at":"2013-12-14T04:35:55.000Z","id":"2244994945"},"includes":{"tweets":[{"created_at":"2021-11-15T19:08:05.000Z","id":"1460323737035677698","text":"Introducing a new era for the Twitter Developer Platform! \\n\\n\\ud83d\\udce3The Twitter API v2 is now the primary API and full of new features\\n\\u23f1Immediate access for most use cases, or apply to get more access for free\\n\\ud83d\\udcd6Removed certain restrictions in the Policy\\nhttps://t.co/Hrm15bkBWJ https://t.co/YFfCDErHsg"}]}}

tests/apis/test_users.py

@@ -98,6 +98,24 @@ def test_get_user(api, helpers):
     assert username_resp["data"]["verified"]
 
 
+@responses.activate
+def test_get_me(api_with_user, helpers):
+    me_data = helpers.load_json_data("testdata/apis/user/me_resp.json")
+
+    responses.add(
+        responses.GET,
+        url=f"https://api.twitter.com/2/users/me",
+        json=me_data,
+    )
+
+    me_resp = api_with_user.get_me(
+        user_fields="created_at",
+        expansions="pinned_tweet_id",
+        tweet_fields="created_at",
+    )
+    assert me_resp.data.id == "2244994945"
+
+
 @responses.activate
 def test_block_and_unblock_user(api_with_user):
     user_id, target_user_id = "123456", "78910"

tests/test_response.py

@@ -0,0 +1,74 @@
+"""
+    Tests for response parser.
+"""
+
+import pytest
+
+import responses
+from pytwitter import PyTwitterError
+
+
+@responses.activate
+def test_parser_response_no_json(api):
+    responses.add(
+        responses.GET,
+        url="https://api.twitter.com/2/users/123",
+        body="",
+    )
+    with pytest.raises(PyTwitterError):
+        api.get_user(user_id="123")
+
+
+@responses.activate
+def test_parser_response_not_ok(api):
+    responses.add(
+        responses.GET,
+        url="https://api.twitter.com/2/users/123",
+        json={
+            "title": "Unauthorized",
+            "type": "about:blank",
+            "status": 401,
+            "detail": "Unauthorized",
+        },
+        status=400,
+    )
+    with pytest.raises(PyTwitterError):
+        api.get_user(user_id="123")
+
+
+@responses.activate
+def test_parser_response_have_error(api):
+    responses.add(
+        responses.GET,
+        url="https://api.twitter.com/2/users/123",
+        json={
+            "errors": {
+                "title": "Unauthorized",
+                "type": "about:blank",
+                "status": 401,
+                "detail": "Unauthorized",
+            }
+        },
+    )
+    with pytest.raises(PyTwitterError):
+        api.get_user(user_id="123")
+
+
+@responses.activate
+def test_parser_response_have_reason_error(api):
+    # Refer: https://developer.twitter.com/en/support/twitter-api/error-troubleshooting
+    responses.add(
+        responses.GET,
+        url="https://api.twitter.com/2/users/123",
+        json={
+            "client_id": "101010101",
+            "required_enrollment": "Standard Basic",
+            "registration_url": "https://developer.twitter.com/en/account",
+            "title": "Client Forbidden",
+            "detail": "This request must be made using an approved developer account that is enrolled in the requested endpoint. Learn more by visiting our documentation.",
+            "reason": "client-not-enrolled",
+            "type": "https://api.twitter.com/2/problems/client-forbidden",
+        },
+    )
+    with pytest.raises(PyTwitterError):
+        api.get_user(user_id="123")