diff --git a/feedback_discord/.metadata b/feedback_discord/.metadata new file mode 100644 index 00000000..af897ac4 --- /dev/null +++ b/feedback_discord/.metadata @@ -0,0 +1,10 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: b22742018b3edf16c6cadd7b76d9db5e7f9064b5 + channel: stable + +project_type: package diff --git a/feedback_discord/CHANGELOG.md b/feedback_discord/CHANGELOG.md new file mode 100644 index 00000000..31490590 --- /dev/null +++ b/feedback_discord/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +* Initial version diff --git a/feedback_discord/LICENSE b/feedback_discord/LICENSE new file mode 100644 index 00000000..770e0e5e --- /dev/null +++ b/feedback_discord/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Jonas Uekötter + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/feedback_discord/README.md b/feedback_discord/README.md new file mode 100644 index 00000000..c41a2432 --- /dev/null +++ b/feedback_discord/README.md @@ -0,0 +1,60 @@ +# feedback_gitlab + +## 🚀 Getting Started + +### Setup + +First, you will need to add `feedback_gitlab` to your `pubspec.yaml`. +The latest version is pub.dev. + +```yaml +dependencies: + flutter: + sdk: flutter + feedback_gitlab: x.y.z # use the latest version found on pub.dev +``` + +Then, run `flutter pub get` in your terminal. + +### Use it + +Just wrap your app in a `BetterFeedback` widget. +To show the feedback view just call `BetterFeedback.of(context).show(...);`. +The callback gets called when the user submits his feedback. + +```dart +import 'package:feedback/feedback.dart'; +import 'package:flutter/material.dart'; + +void main() { + runApp( + BetterFeedback( + child: const MyApp(), + ), + ); +} +``` + +Provide a way to show the feedback panel by calling +```dart + BetterFeedback.of(context).showAndUploadToDiscord( + channel: '#discord-feedback', + discordUrl: 'https://discord.com/api/webhooks/', + ); +``` +Provide a way to hide the feedback panel by calling `BetterFeedback.of(context).hide();` + + +## 📣 Author + +- Jonas Uekötter: [GitHub](https://github.com/ueman) and [Twitter](https://twitter.com/ue_man) + +## Issues, questions and contributing + +You can raise issues [here](https://github.com/ueman/feedback/issues). +If you've got a question do not hesitate to ask it [here](https://github.com/ueman/feedback/discussions). +Contributions are also welcome. You can do a pull request on GitHub [here](https://github.com/ueman/feedback/pulls). Please take a look at [`up for grabs`](https://github.com/ueman/feedback/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) issues first. + +## Sponsoring + +I'm working on my packages on my free-time, but I don't have as much time as I would. If this package or any other package I created is helping you, please consider to [sponsor](https://github.com/ueman#sponsor-me) me. By doing so, I will prioritize your issues or your pull-requests before the others. diff --git a/feedback_discord/analysis_options.yaml b/feedback_discord/analysis_options.yaml new file mode 100644 index 00000000..0bd999bf --- /dev/null +++ b/feedback_discord/analysis_options.yaml @@ -0,0 +1,4 @@ +include: package:flutter_lints/flutter.yaml + +linter: + rules: diff --git a/feedback_discord/example/example.dart b/feedback_discord/example/example.dart new file mode 100644 index 00000000..443a885b --- /dev/null +++ b/feedback_discord/example/example.dart @@ -0,0 +1,73 @@ +import 'package:feedback_discord/feedback_discord.dart'; +import 'package:flutter/material.dart'; + +void main() { + runApp(const BetterFeedback(child: MyApp())); +} + +class MyApp extends StatelessWidget { + const MyApp({super.key}); + @override + Widget build(BuildContext context) { + return MaterialApp( + title: 'Flutter Demo', + theme: ThemeData( + primarySwatch: Colors.blue, + ), + home: const MyHomePage(title: 'Flutter Demo Home Page'), + ); + } +} + +class MyHomePage extends StatefulWidget { + const MyHomePage({super.key, required this.title}); + final String title; + + @override + State createState() => _MyHomePageState(); +} + +class _MyHomePageState extends State { + int _counter = 0; + + void _incrementCounter() { + setState(() { + _counter++; + }); + } + + @override + Widget build(BuildContext context) { + return Scaffold( + appBar: AppBar( + title: Text(widget.title), + ), + body: Center( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + const Text('You have pushed the button this many times:'), + Text( + '$_counter', + style: Theme.of(context).textTheme.headlineMedium, + ), + ElevatedButton( + onPressed: () { + BetterFeedback.of(context).showAndUploadToDiscord( + channel: '#discord-feedback', + discordUrl: 'https://discord.com/api/webhooks/', + ); + }, + child: const Text('Show Feedback view'), + ), + ], + ), + ), + floatingActionButton: FloatingActionButton( + onPressed: _incrementCounter, + tooltip: 'Increment', + child: const Icon(Icons.add), + ), + ); + } +} diff --git a/feedback_discord/lib/feedback_discord.dart b/feedback_discord/lib/feedback_discord.dart new file mode 100644 index 00000000..d906706c --- /dev/null +++ b/feedback_discord/lib/feedback_discord.dart @@ -0,0 +1,5 @@ +library feedback_gitlab; + +export 'package:feedback/feedback.dart'; + +export 'src/feedback_discord.dart'; diff --git a/feedback_discord/lib/src/feedback_discord.dart b/feedback_discord/lib/src/feedback_discord.dart new file mode 100644 index 00000000..bec61f49 --- /dev/null +++ b/feedback_discord/lib/src/feedback_discord.dart @@ -0,0 +1,67 @@ +import 'package:feedback/feedback.dart'; +import 'package:flutter/foundation.dart'; +import 'package:http/http.dart' as http; +import 'package:http_parser/http_parser.dart'; + +/// This is an extension to make it easier to call +/// [showAndUploadToGitLab]. +extension BetterFeedbackDiscord on FeedbackController { + /// Example usage: + /// ```dart + /// import 'package:feedback_gitlab/feedback_gitlab.dart'; + /// + /// RaisedButton( + /// child: Text('Click me'), + /// onPressed: (){ + /// BetterFeedback.of(context).showAndUploadToGitLab + /// projectId: 'gitlab-project-id', + /// apiToken: 'gitlab-api-token', + /// gitlabUrl: 'gitlab.org', // optional, defaults to 'gitlab.com' + /// ); + /// } + /// ) + /// ``` + /// The API token needs access to: + /// - read_api + /// - write_repository + /// See https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#limiting-scopes-of-a-project-access-token + void showAndUploadToDiscord({ + required String channel, + required String discordUrl, + http.Client? client, + }) { + show(uploadToDiscord( + channel: channel, + discordUrl: discordUrl, + client: client, + )); + } +} + +/// See [BetterFeedbackX.showAndUploadToGitLab]. +/// This is just [visibleForTesting]. +@visibleForTesting +OnFeedbackCallback uploadToDiscord({ + required String channel, + required String discordUrl, + http.Client? client, +}) { + final httpClient = client ?? http.Client(); + final baseUrl = discordUrl; + + return (UserFeedback feedback) async { + final uri = Uri.parse( + baseUrl, + ); + final uploadRequest = http.MultipartRequest('POST', uri) + ..fields['content'] = feedback.text + ..files.add(http.MultipartFile.fromBytes( + 'file', + feedback.screenshot, + filename: 'feedback.png', + contentType: MediaType('image', 'png'), + )); + + await httpClient.send(uploadRequest); + }; +} diff --git a/feedback_discord/pubspec.yaml b/feedback_discord/pubspec.yaml new file mode 100644 index 00000000..bf24a695 --- /dev/null +++ b/feedback_discord/pubspec.yaml @@ -0,0 +1,25 @@ +name: feedback_discord +description: A Flutter package for getting better feedback. It allows the user to give interactive feedback directly in the app and upload it as an issue to Discord channel +version: 1.0.0 +homepage: https://uekoetter.dev +repository: https://github.com/ueman/feedback +issue_tracker: https://github.com/ueman/feedback/issues + +environment: + sdk: '>=3.0.0 <4.0.0' + flutter: '>=3.10.0' + +dependencies: + flutter: + sdk: flutter + feedback: ^3.0.0 + http: ^1.0.0 + http_parser: ^4.0.0 + +dev_dependencies: + flutter_test: + sdk: flutter + flutter_lints: ^3.0.0 + +flutter: + uses-material-design: true \ No newline at end of file diff --git a/feedback_discord/test/feedback_discord_test.dart b/feedback_discord/test/feedback_discord_test.dart new file mode 100644 index 00000000..eeaf327e --- /dev/null +++ b/feedback_discord/test/feedback_discord_test.dart @@ -0,0 +1,90 @@ +import 'dart:async'; +import 'dart:convert'; +import 'dart:typed_data'; + +import 'package:feedback_discord/feedback_discord.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:http/http.dart'; +import 'package:http_parser/http_parser.dart'; + +void main() { + test('uploads', () async { + final mockClient = MockClient(); + var onFeedback = uploadToDiscord( + channel: '#discord-feedbacks', + discordUrl: 'https://discord.com/api/webhooks/', + client: mockClient, + ); + + onFeedback(UserFeedback( + screenshot: Uint8List.fromList([]), + text: 'foo bar', + )); + + final result = await mockClient.completer.future; + expect(result, true); + }); +} + +class MockClient extends BaseClient { + int calls = 0; + Completer completer = Completer(); + + @override + Future send(BaseRequest request) async { + calls++; + if (request is MultipartRequest) { + final response = toStreamedResponse( + request, + onMultipartRequest(request), + ); + + completer.complete(true); + return response; + } + + fail('This should not be reached'); + } + + Response onRequest(Request request) { + expect(request.method, 'POST'); + expect( + request.url, + Uri.parse( + 'https://discord.com/api/webhooks/', + ), + ); + return Response('', 200); + } + + Response onMultipartRequest(MultipartRequest request) { + expect(request.method, 'POST'); + expect(request.url, Uri.parse('https://discord.com/api/webhooks/')); + expect(request.files.length, 1); + + var file = request.files.first; + + expect(file.field, 'file'); + expect(file.contentType.mimeType, 'image/png'); + expect(file.filename, 'feedback.png'); + expect( + file.contentType.mimeType, + MediaType('image', 'png').mimeType, + ); + + return Response(jsonEncode({}), 200); + } + + StreamedResponse toStreamedResponse(BaseRequest request, Response response) { + return StreamedResponse( + ByteStream.fromBytes(response.bodyBytes), + response.statusCode, + contentLength: response.contentLength, + request: request, + headers: response.headers, + isRedirect: response.isRedirect, + persistentConnection: response.persistentConnection, + reasonPhrase: response.reasonPhrase, + ); + } +}