add wrapper for Stream in API v2

Author: boogheta

README

@@ -37,8 +37,9 @@ The list of most accessible functions is listed at:
 
 **[https://developer.twitter.com/en/docs/api-reference-index](https://developer.twitter.com/en/docs/api-reference-index)**
 
+
 Examples with Twitter API v2:
-_____________________________
++++++++++++++++++++++++++++++   
 
 ```python
 from twitter import *
@@ -76,10 +77,35 @@ t.tweets(
         "poll.fields":  "duration_minutes,end_datetime,id,options,voting_status"
     })
 
+# The Stream also has its own wrapper:
+ts = TwitterStream2(auth=OAuth2(bearer_token=BEARER_TOKEN))
+
+# Then calling it behaves like python generators. For instance the sample stream:
+for tweet in ts.tweets.sample.stream():
+    print(tweet)
+
+# The same applies to the regular filter stream:
+for tweet in ts.tweets.search.stream():
+    print(tweet)
+
+# Although it does not anymore take any filter argument and needs to be
+# controlled separately using the regular Twitter class.
+# To know which rules apply, just call:
+t.tweets.search.stream.rules()
+# And to add new rules, send POST json queries to the same route:
+t.tweets.search.stream.rules(_json={"add": [{"value": "python"}]})
+
+# Then call the stream as described above:
+for tweet in ts.tweets.search.stream():
+    print(tweet)
+
+# Get more details on rules possibilities and syntax in the officiel documentation:
+# https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/api-reference/post-tweets-search-stream-rules
+
 ```
 
 Examples with Twitter API Standard v1.1:
-________________________________________
+++++++++++++++++++++++++++++++++++++++++
 
 ```python
 from twitter import *

twitter/__init__.py

@@ -16,7 +16,7 @@
 from .oauth2 import (
     OAuth2, read_bearer_token_file, write_bearer_token_file,
     __doc__ as oauth2_doc)
-from .stream import TwitterStream
+from .stream import TwitterStream, TwitterStream2
 from .oauth_dance import oauth_dance, oauth2_dance
 
 __doc__ = __doc__ or ""
@@ -78,6 +78,7 @@
     "TwitterHTTPError",
     "TwitterResponse",
     "TwitterStream",
+    "TwitterStream2",
     "UserPassAuth",
     "write_bearer_token_file",
     "write_token_file",

twitter/api.py

@@ -622,17 +622,15 @@ def __init__(
 class Twitter2(Twitter):
 
     def __init__(
-            self, secure=True, auth=None, retry=False, verify_context=True):
-
-        Twitter.__init__(
             self,
             domain="api.twitter.com",
             api_version="2",
             format="",
-            auth=auth,
-            retry=retry,
-            secure=secure,
-            verify_context=verify_context)
+            secure=True, auth=None, retry=False, verify_context=True):
+
+        Twitter.__init__(
+            self, domain=domain, api_version=api_version, format=format,
+            auth=auth, retry=retry, secure=secure, verify_context=verify_context)
 
 
 __all__ = ["Twitter", "Twitter2", "TwitterError", "TwitterHTTPError", "TwitterResponse"]

twitter/stream.py

@@ -278,3 +278,23 @@ def _handle_response(self, req, uri, arg_data, _timeout=None):
             callable_cls=TwitterStreamCall,
             secure=secure, uriparts=uriparts, timeout=timeout, gzip=False,
             retry=False, verify_context=verify_context)
+
+class TwitterStream2(TwitterCall):
+
+    def __init__(self, domain="api.twitter.com", secure=True, auth=None,
+                 api_version='2', block=True, timeout=None,
+                 heartbeat_timeout=90.0, verify_context=True):
+        uriparts = (str(api_version),)
+
+        class TwitterStream2Call(TwitterCall):
+            def _handle_response(self, req, uri, arg_data, _timeout=None):
+                return handle_stream_response(
+                    req, uri, arg_data, block,
+                    _timeout or timeout, heartbeat_timeout, verify_context)
+
+        TwitterCall.__init__(
+            self, auth=auth, format="", domain=domain,
+            callable_cls=TwitterStream2Call,
+            secure=secure, uriparts=uriparts, timeout=timeout, gzip=False,
+            retry=False, verify_context=verify_context)
+