Prepare for 0.9.2 release

draw-dev · Mar 25, 2021 · c26065f · c26065f
1 parent 26a2593
commit c26065f
Show file tree

Hide file tree

Showing 37 changed files with 119 additions and 72 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 Change Log
 =================================
 
+## Version 0.9.2 (2021/03/25)
+* Fixed issues with `limit` parameter for listing generators.
+
 ## Version 0.9.1 (2020/01/09)
 * Fixed issue where `SubredditRef.search` would throw a type error.
 

diff --git a/lib/draw.dart b/lib/draw.dart
@@ -21,6 +21,7 @@ export 'package:draw/src/listing/mixins/base.dart'
     show BaseListingMixin, Sort, TimeFilter;
 export 'package:draw/src/listing/mixins/gilded.dart';
 export 'package:draw/src/listing/mixins/redditor.dart';
+export 'package:draw/src/listing/mixins/rising.dart';
 export 'package:draw/src/listing/mixins/subreddit.dart';
 export 'package:draw/src/models/message.dart';
 export 'package:draw/src/models/multireddit.dart'

diff --git a/lib/src/listing/listing_generator.dart b/lib/src/listing/listing_generator.dart
@@ -4,6 +4,7 @@
 // can be found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:developer';
 
 import 'package:draw/src/reddit.dart';
 
@@ -44,12 +45,12 @@ abstract class ListingGenerator {
       bool objectify = true}) async* {
     final kLimitKey = 'limit';
     final kAfterKey = 'after';
-    final nullLimit = 1024;
+    final nullLimit = 100;
     final paramsInternal = (params == null)
         ? Map<String, String>()
         : Map<String, String>.from(params);
-    final _limit = limit ?? nullLimit;
-    paramsInternal[kLimitKey] = _limit.toString();
+    final _limit = limit;
+    paramsInternal[kLimitKey] = (_limit ?? nullLimit).toString();
 
     // If after is provided, we'll start getting objects older than the object
     // ID specified.

diff --git a/lib/src/models/mixins/voteable.dart b/lib/src/models/mixins/voteable.dart
@@ -15,6 +15,17 @@ enum VoteState {
   downvoted,
 }
 
+int _voteStateToIndex(VoteState vote) {
+  switch (vote) {
+    case VoteState.none:
+      return 0;
+    case VoteState.upvoted:
+      return 1;
+    case VoteState.downvoted:
+      return -1;
+  }
+}
+
 /// A mixin which provides voting functionality for [Comment] and [Submission].
 mixin VoteableMixin implements RedditBaseInitializedMixin {
   Reddit get reddit;
@@ -46,22 +57,53 @@ mixin VoteableMixin implements RedditBaseInitializedMixin {
     }
   }
 
-  Future<void> _vote(String direction, bool waitForResponse) async {
+  void _updateScore(VoteState newVote) {
+    if (vote == VoteState.upvoted) {
+      if (newVote == VoteState.downvoted) {
+        data['score'] = score - 2;
+      } else if (newVote == VoteState.none) {
+        data['score'] = score - 1;
+      }
+    } else if (vote == VoteState.none) {
+      if (newVote == VoteState.downvoted) {
+        data['score'] = score - 1;
+      } else if (newVote == VoteState.upvoted) {
+        data['score'] = score + 1;
+      }
+    } else if (vote == VoteState.downvoted) {
+      if (newVote == VoteState.upvoted) {
+        data['score'] = score + 2;
+      } else if (newVote == VoteState.none) {
+        data['score'] = score + 1;
+      }
+    }
+  }
+
+  Future<void> _vote(VoteState direction, bool waitForResponse) async {
+    if (vote == direction) {
+      return;
+    }
     final response = reddit.post(
-        apiPath['vote'], {'dir': direction, 'id': fullname},
+        apiPath['vote'],
+        {
+          'dir': _voteStateToIndex(direction).toString(),
+          'id': fullname,
+        },
         discardResponse: true);
     if (waitForResponse) {
       await response;
     }
 
+    _updateScore(direction);
+
     switch (direction) {
-      case '0':
+      case VoteState.none:
         data['likes'] = null;
         break;
-      case '1':
+      case VoteState.upvoted:
         data['likes'] = true;
         break;
-      case '-1':
+      case VoteState.downvoted:
         data['likes'] = false;
     }
   }
@@ -72,21 +114,21 @@ mixin VoteableMixin implements RedditBaseInitializedMixin {
   /// voting by bots). See Reddit rules for more details on what is considered
   /// vote cheating or manipulation.
   Future<void> clearVote({bool waitForResponse = true}) async =>
-      _vote('0', waitForResponse);
+      _vote(VoteState.none, waitForResponse);
 
   /// Clear the authenticated user's vote on the object.
   ///
   /// Note: votes must be cast on behalf of a human user (i.e., no automatic
   /// voting by bots). See Reddit rules for more details on what is considered
   /// vote cheating or manipulation.
   Future<void> downvote({bool waitForResponse = true}) async =>
-      _vote('-1', waitForResponse);
+      _vote(VoteState.downvoted, waitForResponse);
 
   /// Clear the authenticated user's vote on the object.
   ///
   /// Note: votes must be cast on behalf of a human user (i.e., no automatic
   /// voting by bots). See Reddit rules for more details on what is considered
   /// vote cheating or manipulation.
   Future<void> upvote({bool waitForResponse = true}) async =>
-      _vote('1', waitForResponse);
+      _vote(VoteState.upvoted, waitForResponse);
 }
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: draw
-version: 0.9.1
+version: 0.9.2
 description: 'A fully-featured Reddit API wrapper for Dart, inspired by PRAW.'
 homepage: 'https://github.com/draw-dev/DRAW'
 

diff --git a/test/inbox/lib_inbox_all.json b/test/inbox/lib_inbox_all.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/inbox/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_comment_replies.json b/test/inbox/lib_inbox_comment_replies.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/comments/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_mark_read_unread.json b/test/inbox/lib_inbox_mark_read_unread.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/unread/",
-      "{mark: false, limit: 1024}"
+      "{mark: false, limit: 100}"
     ],
     "response": {
       "kind": "Listing",
@@ -58,7 +58,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/unread/",
-      "{mark: false, limit: 1024}"
+      "{mark: false, limit: 100}"
     ],
     "response": {
       "kind": "Listing",
@@ -84,7 +84,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/unread/",
-      "{mark: false, limit: 1024}"
+      "{mark: false, limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_mentions.json b/test/inbox/lib_inbox_mentions.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/mentions",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_messages.json b/test/inbox/lib_inbox_messages.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/messages/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_sent.json b/test/inbox/lib_inbox_sent.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/sent/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_submission_replies.json b/test/inbox/lib_inbox_submission_replies.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/selfreply/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/inbox/lib_inbox_unread.json b/test/inbox/lib_inbox_unread.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/message/unread/",
-      "{mark: false, limit: 1024}"
+      "{mark: false, limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/submission/lib_submission_hide_unhide.json b/test/submission/lib_submission_hide_unhide.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/new",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/submission/lib_submission_hide_unhide_multiple.json b/test/submission/lib_submission_hide_unhide_multiple.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/new",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/subreddit/lib_subreddit_banned.json b/test/subreddit/lib_subreddit_banned.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/about/banned/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",
@@ -275,7 +275,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/about/banned/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",
@@ -307,7 +307,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/about/banned/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/subreddit/lib_subreddit_contributor.json b/test/subreddit/lib_subreddit_contributor.json
@@ -258,7 +258,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/about/contributors/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",
@@ -299,7 +299,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/about/contributors/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "kind": "Listing",

diff --git a/test/subreddit/lib_subreddit_flair_call.json b/test/subreddit/lib_subreddit_flair_call.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [

diff --git a/test/subreddit/lib_subreddit_flair_delete.json b/test/subreddit/lib_subreddit_flair_delete.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [
@@ -31,7 +31,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": []

diff --git a/test/subreddit/lib_subreddit_flair_delete_all.json b/test/subreddit/lib_subreddit_flair_delete_all.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [
@@ -19,7 +19,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [
@@ -50,7 +50,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": []

diff --git a/test/subreddit/lib_subreddit_flair_set_flair.json b/test/subreddit/lib_subreddit_flair_set_flair.json
@@ -3,7 +3,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [
@@ -31,7 +31,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [

diff --git a/test/subreddit/lib_subreddit_flair_update.json b/test/subreddit/lib_subreddit_flair_update.json
@@ -24,7 +24,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": [
@@ -66,7 +66,7 @@
     "always": false,
     "request": [
       "https://oauth.reddit.com/r/drawapitesting/api/flairlist/",
-      "{limit: 1024}"
+      "{limit: 100}"
     ],
     "response": {
       "users": []