feat: Implement Tweets:Volume streams endpoint #148

robertodoering · 2022-05-21T18:18:04Z

1. Description

This PR adds support for streamed responses and implements the Volume streams endpoint.

To handle the streamed responses, we can use the send method on http requests.
Since they return a StreamedResponse (rather than a Response), some changed were done to the TwitterException to allow also handling exceptions for streamed responses.

The endpoint methods then just return a Future<Stream<T>>, which the user can handle like any other stream.

E.g.:

final response = await tweetsService.volumeStreams();

await for (final tweet in response) {
  print('received tweet: $tweet');
}

final response = await tweetsService.volumeStreams();

response.listen(
  (tweet) => print('received tweet: $tweet'),
  onError: (e) => print('received error: $e'),
  cancelOnError: false,
);

1.1. Checklist

The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
I have read the Contributor Guide and followed the process outlined for submitting PRs.
I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation in docs and added dartdoc comments with ///.
I have updated/added relevant examples in examples.

1.2. Breaking Change

Yes, this is a breaking change.
No, this is not a breaking change.

1.3. Related Issues

Closes #14

github-actions

Thanks for your contribution! :)

robertodoering · 2022-05-21T18:22:51Z

Hey @myConsciousness, thanks again for this great wrapper of the v2 api :)
Feel free to review this PR and request / make changes as you see fit.

I have updated/added relevant examples in examples.

Where should I add examples to? The examples/examples.dart file?

codecov-commenter · 2022-05-21T23:15:33Z

Codecov Report

Merging #148 (a01fff9) into main (80defc5) will decrease coverage by 1.16%.
The diff coverage is 74.00%.

@@            Coverage Diff             @@
##             main     #148      +/-   ##
==========================================
- Coverage   84.44%   83.27%   -1.17%     
==========================================
  Files          43       43              
  Lines         527      568      +41     
==========================================
+ Hits          445      473      +28     
- Misses         82       95      +13

Impacted Files	Coverage Δ
lib/src/client/client_context.dart	`38.70% <0.00%> (-5.74%)`	⬇️
lib/src/client/oauth1_client.dart	`0.00% <0.00%> (ø)`
lib/src/client/oauth2_client.dart	`40.62% <0.00%> (-7.53%)`	⬇️
lib/src/client/client.dart	`100.00% <100.00%> (ø)`
lib/src/service/base_service.dart	`93.65% <100.00%> (+1.65%)`	⬆️
lib/src/service/tweets/tweets_service.dart	`99.16% <100.00%> (+0.04%)`	⬆️
lib/src/twitter_exception.dart	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 80defc5...a01fff9. Read the comment docs.

myConsciousness · 2022-05-21T23:33:16Z

Hi @robertodoering , I've seen a few differences and this is a great implementation! :) And thanks for your feedback, I'm also very glad to welcome you as a pioneer of the Twitter API library in the Dart language.

Where should I add examples to? The examples/examples.dart file?

Yes, Stream is a specification that stands out from the rest of the Twitter API, so if you have time, please add examples to
examples/examples.dart 👍

Also it's almost empty now, but I plan to create the following repository that will manage examples of this library's use for each endpoint.

Okay, I'll check your pull request when I can touch my laptop, thank you! :)

myConsciousness · 2022-05-22T23:56:18Z

lib/src/service/tweets/tweets_service.dart

+  /// ## Reference
+  ///
+  /// - https://developer.twitter.com/en/docs/twitter-api/tweets/volume-streams/api-reference/get-tweets-sample-stream
+  Future<Stream<TweetData>> volumeStreams({int? backfillMinutes});


It seems the expansions parameter is missing, so I add List<TweetExpansion>? expansions :)

myConsciousness · 2022-05-23T00:01:35Z

lib/src/service/tweets/tweets_service.dart

+  /// ## Reference
+  ///
+  /// - https://developer.twitter.com/en/docs/twitter-api/tweets/volume-streams/api-reference/get-tweets-sample-stream
+  Future<Stream<TweetData>> volumeStreams({int? backfillMinutes, List<TweetExpansion>? expansions});


Also please let me fix method name to connectVolumeStreams, because there are other Stream-related endpoints, but I intend to unify the prefixes of those endpoints with connect :)

myConsciousness · 2022-05-23T00:12:13Z

Thanks for your contribution @robertodoering ! 🚀

myConsciousness · 2022-05-23T00:12:19Z

bors merge

bors · 2022-05-23T00:14:05Z

Build succeeded:

robertodoering added 14 commits May 21, 2022 17:57

feat: Updated TwitterException

14fbb3c

feat: Added send in clients for streaming responses

9ed39d4

feat: Added volumeStream in TweetsService

32875a7

chore: Update example

00b5358

Merge branch 'main' into volume-stream

e521749

feaT: Added tweet expansions to volume stream

f8baf27

fix: Fixed naming

3f97d73

fix: Fixed send query parameters

c7ee7e1

test: Added send stub

ea5cf98

test: Added volumeStreams test

669ff47

test: Test volumeStream with an error

c45ba8b

chore: Update changelog

4f0b263

refactor: Updated twitter exception body

7892a01

chore: Fix import whitespaces

6867fc6

github-actions bot reviewed May 21, 2022

View reviewed changes

myConsciousness assigned myConsciousness and robertodoering May 21, 2022

myConsciousness added enhancement New feature or request service/Tweets do not merge yet labels May 21, 2022

myConsciousness self-requested a review May 21, 2022 23:15

robertodoering and others added 2 commits May 22, 2022 16:44

feat: add using stream example

d988be6

Merged to v2.1.0

7ce89a7

myConsciousness reviewed May 22, 2022

View reviewed changes

fix: added missing parameter

5428c0b

myConsciousness reviewed May 23, 2022

View reviewed changes

fix: renamed method to connectVolumeStreams

14ccaee

myConsciousness added 3 commits May 23, 2022 09:04

fix: renamed method to connectVolumeStreams

eb06ddf

fix: renamed method to connectVolumeStreams

6730de9

fix: fixed for lines_longer_than_80_chars

a01fff9

myConsciousness removed the do not merge yet label May 23, 2022

bors bot merged commit 9876daf into twitter-dart:main May 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement Tweets:Volume streams endpoint #148

feat: Implement Tweets:Volume streams endpoint #148

robertodoering commented May 21, 2022 •

edited

Loading

github-actions bot left a comment

robertodoering commented May 21, 2022

codecov-commenter commented May 21, 2022 •

edited

Loading

myConsciousness commented May 21, 2022

myConsciousness May 22, 2022

myConsciousness May 23, 2022

myConsciousness commented May 23, 2022

myConsciousness commented May 23, 2022

bors bot commented May 23, 2022

feat: Implement Tweets:Volume streams endpoint #148

feat: Implement Tweets:Volume streams endpoint #148

Conversation

robertodoering commented May 21, 2022 • edited Loading

1. Description

1.1. Checklist

1.2. Breaking Change

1.3. Related Issues

github-actions bot left a comment

Choose a reason for hiding this comment

robertodoering commented May 21, 2022

codecov-commenter commented May 21, 2022 • edited Loading

Codecov Report

myConsciousness commented May 21, 2022

myConsciousness May 22, 2022

Choose a reason for hiding this comment

myConsciousness May 23, 2022

Choose a reason for hiding this comment

myConsciousness commented May 23, 2022

myConsciousness commented May 23, 2022

bors bot commented May 23, 2022

robertodoering commented May 21, 2022 •

edited

Loading

codecov-commenter commented May 21, 2022 •

edited

Loading