splitwise_api 3.0.0

splitwise_api: ^3.0.0 copied to clipboard

Complete rewrite against Splitwise's official OpenAPI 3.0.1 specification. This release is not backwards compatible.

Breaking changes #

• Authentication is now OAuth 2.0 or a personal API key. OAuth 1.0 and the oauth1 dependency are gone. Existing OAuth 1.0 tokens cannot be converted; users must authorize again. The consumer key/secret from https://secure.splitwise.com/apps is reused as the OAuth 2.0 client ID/secret.
• Typed models instead of raw strings. Every method returns a model (CurrentUser, Group, Expense, …) or void; nothing returns a JSON String or an int status code any more.
• Failures are exceptions. Non-2xx responses throw SplitwiseHttpException (with SplitwiseBadRequestException, SplitwiseUnauthorizedException, SplitwiseForbiddenException, SplitwiseNotFoundException, SplitwiseRateLimitException); a 200 that reports success: false or non-empty errors throws SplitwiseRequestFailedException.
• POST parameters are sent as a JSON body instead of query-string parameters. BodyEncoding.formUrlEncoded is available as an escape hatch; createFriends always uses it.
• parseSentence was removed: parse_sentence is no longer part of the Splitwise API.
• Minimum Dart SDK is 3.9.
• The unconditional print of every response body was removed.
• SplitwiseNotification and SplitwiseCategory are named to avoid clashing with Flutter's Notification and Category.

Migration from 2.x #

Fixed #

• deleteGroup, unDeleteGroup, addUserToGroup, removeUserFromGroup, deleteFriend, deleteExpense and unDeleteExpense threw NoSuchMethodError at runtime (they inspected .success on a String).
• updateUser posted to a malformed URL.
• addUserToGroup and removeUserFromGroup ignored their arguments.
• createExpense discarded the response.
• dart analyze failed because lints was not a dev dependency.

Added #

• Test suite: offline tests against the committed OpenAPI document (spec/openapi.json), including a coverage test that fails if any documented operation lacks a client method, plus an opt-in live suite (SPLITWISE_API_KEY=... dart test --tags live).
• SplitwiseClient(httpClient:) for injecting an http.Client.

Notes on the specification #

• create_friend's schema lists email as required but the property is named user_email; this package sends user_email.
• create_group's description documents users__{i}__user_id while its example shows users__{i}__id; this package sends user_id.
• The OAuth 2.0 endpoints are resolved against https://www.splitwise.com/ (the host used by the Splitwise web app and other SDKs) and can be overridden with SplitwiseOAuth2(oauthBaseUrl:).

• Added explicit return type annotations to all 31 methods
• Added analysis_options.yaml with lints_core package
• Fixed all linting issues to achieve perfect static analysis (50/50 points)
• Now fully compliant with Pana analysis requirements

• Updated dependencies to latest versions
• Fixed unused import warning in test file
• Achieved perfect pub.flutter-io.cn score (160/160 points)
• All static analysis checks passing

• Versioning Error

• Fixed some null-safety induced bugs
• Removed Data Classes

• Migrated to null-safety
• Changed the Data Classes

• Major BugFix

• Minor BugFix

• Added Data Class
• Added Token Helper

• Fixed Comments and first Release

• BugFix and added Comments

[0.0.2 ] - June 29 2k20 #

• BugFix and README update

• Added all methods
• No data classes as of now
• Some bugs that need to be fixed