Merge pull request #116 from MerleLiuKun/feat-timelines

Feat timelines

Author: MerleLiuKun

docs/docs/usage/tweets/timelines.md

@@ -7,6 +7,13 @@ api.get_timelines(user_id="2244994945")
 # Response(data=[Tweet(id=1364275610764201984, text=If you're newly approved for the Academic...), Tweet(id=1362876655061073928, text=From our living rooms to yours 🐱‍💻🛋️Our...), Tweet(id=1362439338978467841, text=“To quote my creator Jerome Gangneux, I always...), Tweet(id=1362439338169016324, text=“In the 20th century, managers managed humans,...), Tweet(id=1362439336910675970, text=Meet one of the useful Twitter bots out there:...), Tweet(id=1359912509940011010, text=Valentine’s Day is approaching! 💙 Over the...), Tweet(id=1359554366051504129, text=Go ahead, follow another puppy account. We...), Tweet(id=1357371424487268354, text=Learn how academics can get historical Tweets...), Tweet(id=1356991771553583106, text=Who knew an API could be delicious?...), Tweet(id=1354215875998437376, text=RT @TwitterOSS: Today we’re happy to share...)])
 ```
 
+Get collection of the most recent Tweets and Retweets posted by you and users you follow
+
+```python
+my_api.get_timelines_reverse_chronological(user_id="2244994945")
+# Response(data=[Tweet(id=1524796546306478083, text=Today marks the launch of Devs in the Details...), Tweet(id=1524468552404668416, text=📢 Join @jessicagarson @alanbenlee and @i_am_daniele tomorrow...))
+```
+
 Get tweets which mention target user
 
 ```python

pyproject.toml

@@ -29,7 +29,7 @@ Authlib = "^0.15.4"
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.5"
 pytest-cov = "^3.0.0"
-responses = "^0.12.1"
+responses = "^0.17.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pytwitter/api.py

@@ -718,6 +718,76 @@ def get_timelines(
             return_json=return_json,
         )
 
+    def get_timelines_reverse_chronological(
+        self,
+        user_id: str,
+        *,
+        start_time: Optional[str] = None,
+        end_time: Optional[str] = None,
+        since_id: Optional[str] = None,
+        until_id: Optional[str] = None,
+        max_results: Optional[int] = None,
+        pagination_token: Optional[str] = None,
+        exclude: Optional[Union[str, List, Tuple]] = None,
+        tweet_fields: Optional[Union[str, List, Tuple]] = None,
+        expansions: Optional[Union[str, List, Tuple]] = None,
+        user_fields: Optional[Union[str, List, Tuple]] = None,
+        media_fields: Optional[Union[str, List, Tuple]] = None,
+        place_fields: Optional[Union[str, List, Tuple]] = None,
+        poll_fields: Optional[Union[str, List, Tuple]] = None,
+        return_json: bool = False,
+    ) -> Union[dict, md.Response]:
+        """
+        Allows you to retrieve a collection of the most recent Tweets and Retweets posted by you and users you follow.
+        This endpoint returns up to the last 3200 Tweets.
+
+        :param user_id: Unique identifier of the user that is requesting their chronological home timeline.
+        :param start_time: Oldest or earliest UTC timestamp for tweets, format YYYY-MM-DDTHH:mm:ssZ.
+        :param end_time: Newest or most recent UTC timestamp for tweets, format YYYY-MM-DDTHH:mm:ssZ.
+        :param since_id: Greater than (that is, more recent than) tweet id for response. Exclude this since_id.
+        :param until_id: Less than (that is, older than) tweet id for response. Exclude this until_id.
+        :param max_results: The maximum number of results to be returned per page. Number between 5 and the 100.
+        By default, each page will return 10 results.
+        :param pagination_token: Token for the pagination.
+        :param exclude: Fields for types of Tweets to exclude from the response.
+        :param tweet_fields: Fields for the tweet object.
+        :param expansions: Fields for the expansions.
+        :param user_fields: Fields for the user object, Expansion required.
+        :param media_fields: Fields for the media object, Expansion required.
+        :param place_fields: Fields for the place object, Expansion required.
+        :param poll_fields: Fields for the poll object, Expansion required.
+        :param return_json: Type for returned data. If you set True JSON data will be returned.
+        :return: Response instance or json.
+        """
+        args = {
+            "start_time": start_time,
+            "end_time": end_time,
+            "since_id": since_id,
+            "until_id": until_id,
+            "exclude": enf_comma_separated(name="exclude", value=exclude),
+            "tweet.fields": enf_comma_separated(
+                name="tweet_fields", value=tweet_fields
+            ),
+            "expansions": enf_comma_separated(name="expansions", value=expansions),
+            "user.fields": enf_comma_separated(name="user_fields", value=user_fields),
+            "media.fields": enf_comma_separated(
+                name="media_fields", value=media_fields
+            ),
+            "place.fields": enf_comma_separated(
+                name="place_fields", value=place_fields
+            ),
+            "poll.fields": enf_comma_separated(name="poll_fields", value=poll_fields),
+            "max_results": max_results,
+            "pagination_token": pagination_token,
+        }
+        return self._get(
+            url=f"{self.BASE_URL_V2}/users/{user_id}/timelines/reverse_chronological",
+            params=args,
+            cls=md.Tweet,
+            multi=True,
+            return_json=return_json,
+        )
+
     def get_mentions(
         self,
         user_id: str,

pytwitter/rate_limit.py

@@ -60,6 +60,11 @@ def get_limit(self, auth_type, method="GET"):
     LIMIT_APP_GET=1500,
     LIMIT_USER_GET=900,
 )
+USER_TIMELINE_REVERSE = Endpoint(
+    resource="/users/:id/timelines/reverse_chronological",
+    regex=re.compile(r"/users/\d+/timelines/reverse_chronological"),
+    LIMIT_USER_GET=180,
+)
 USER_MENTIONS = Endpoint(
     resource="/users/:id/mentions",
     regex=re.compile(r"/users/\d+/mentions"),
@@ -326,6 +331,7 @@ def get_limit(self, auth_type, method="GET"):
     TWEET_BY_ID,
     TWEETS_BY_ID,
     USER_TIMELINE,
+    USER_TIMELINE_REVERSE,
     USER_MENTIONS,
     TWEET_SEARCH_RECENT,
     TWEET_SEARCH_ALL,

testdata/apis/timeline/timeline_reverse_chronological.json

@@ -0,0 +1 @@
+{"data":[{"created_at":"2022-05-12T17:00:00.000Z","text":"Today marks the launch of Devs in the Details, a technical video series made for developers by developers building with the Twitter API.  🚀nnIn this premiere episode, @jessicagarson walks us through how she built @FactualCat #WelcomeToOurTechTalkn⬇️nnhttps://t.co/nGa8JTQVBJ","author_id":"2244994945","id":"1524796546306478083"},{"created_at":"2022-05-11T19:16:40.000Z","text":"📢 Join @jessicagarson @alanbenlee and @i_am_daniele tomorrow, May 12  | 5:30 ET / 2:30pm PT as they discuss the future of bots https://t.co/sQ2bIO1fz6","author_id":"2244994945","id":"1524468552404668416"},{"created_at":"2022-05-09T20:12:01.000Z","text":"Do you make bots with the Twitter API? 🤖nnJoin @jessicagarson @alanbenlee and @iamdaniele on Thursday, May 12  | 5:30 ET / 2:30pm PT as they discuss the future of bots and answer any questions you might have. 🎙📆⬇️nnhttps://t.co/2uVt7hCcdG","author_id":"2244994945","id":"1523757705436958720"},{"created_at":"2022-05-06T18:19:54.000Z","text":"If you’d like to apply, or would like to nominate someone else for the program, please feel free to fill out the following form:nnhttps://t.co/LUuWj24HLu","author_id":"2244994945","id":"1522642324781633536"},{"created_at":"2022-05-06T18:19:53.000Z","text":"We’ve gone into more detail on each Insider in our forum post. nnJoin us in congratulating the new additions! 🥳nnhttps://t.co/0r5maYEjPJ","author_id":"2244994945","id":"1522642323535847424"}],"includes":{"users":[{"created_at":"2013-12-14T04:35:55.000Z","name":"Twitter Dev","username":"TwitterDev","id":"2244994945"}]},"meta":{"result_count":5,"newest_id":"1524796546306478083","oldest_id":"1522642323535847424","next_token":"7140dibdnow9c7btw421dyz6jism75z99gyxd8egarsc4"}}

tests/apis/test_timelines.py

@@ -30,6 +30,32 @@ def test_get_timelines(api, helpers):
     assert resp.meta.newest_id == "1364275610764201984"
 
 
+@responses.activate
+def test_get_timelines_reverse_chronological(api_with_user, helpers):
+    user_id = "2244994945"
+    timelines_data = helpers.load_json_data(
+        "testdata/apis/timeline/timeline_reverse_chronological.json"
+    )
+
+    responses.add(
+        responses.GET,
+        url=f"https://api.twitter.com/2/users/{user_id}/timelines/reverse_chronological",
+        json=timelines_data,
+    )
+
+    resp = api_with_user.get_timelines_reverse_chronological(
+        user_id=user_id,
+        tweet_fields=["conversation_id", "lang"],
+        expansions="author_id",
+        user_fields=["created_at", "entities"],
+        max_results=5,
+    )
+
+    assert len(resp.data) == 5
+    assert resp.data[0].id == "1524796546306478083"
+    assert resp.meta.newest_id == "1524796546306478083"
+
+
 @responses.activate
 def test_get_mentions(api, helpers):
     user_id = "2244994945"

tests/streams/test_stream.py

@@ -7,6 +7,7 @@
 
 import pytest
 import responses
+from responses import matchers
 
 from pytwitter import StreamApi, PyTwitterError
 
@@ -70,35 +71,37 @@ def callback(request):
         else:
             return 200, {}, "\r\n"
 
+    req_kwargs = {"stream": True}
     responses.add(
         responses.CallbackResponse(
             responses.GET,
             url="https://api.twitter.com/2/tweets/sample/stream",
             callback=callback,
-            stream=True,
             content_type="application/json",
-        )
+        ),
+        match=[matchers.request_kwargs_matcher(req_kwargs)],
     )
 
     stream_api = MyStreamApi(bearer_token="bearer token")
 
     stream_api.sample_stream(backfill_minutes=1)
 
-    assert stream_api.running == False
+    assert not stream_api.running
     assert stream_api.tweet_max_count == 10
 
 
 @responses.activate
 @patch("time.sleep", return_value=None)
 def test_stream_error(patched_time_sleep):
+    req_kwargs = {"stream": True}
     responses.add(
         responses.Response(
             responses.GET,
             url="https://api.twitter.com/2/tweets/search/stream",
-            stream=True,
             content_type="application/json",
             status=400,
-        )
+        ),
+        match=[matchers.request_kwargs_matcher(req_kwargs)],
     )
 
     api = StreamApi(bearer_token="bearer token", max_retries=10)