Tests

CHANGELOG.md

@@ -1,8 +1,11 @@
-# Changelog
+## 0.0.2
 
-All notable changes to this project will be documented in this file.
+- chore: write tests
+- refactor: Created `TenorHttpClient` so testing can be achieved.
+  - `getGifs` is now `TenorHttpClient().getGifs(...)`
+  - `serverRequest` is now `TenorHttpClient().request(...)`
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/).
+[All Code Changes](https://github.com/Flyclops/tenor_dart/compare/0.0.1...0.0.2)
 
 ## 0.0.1
 

CONTRIBUTING.md

@@ -4,6 +4,15 @@
 
 Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
+## How Can You Contribute?
+
+- Pick up any issue marked with "[good first issue](https://github.com/flyclops/tenor_dart/issues?q=is:open+is:issue+label:%22good+first+issue%22)"
+- Propose any feature, enhancement
+- Report a bug
+- Fix a bug
+- Write and improve some documentation
+- Send in a Pull Request 🙏
+
 ## Creating a Pull Request
 
 Before creating a pull request please:
@@ -12,10 +21,10 @@ Before creating a pull request please:
 2. Install all dependencies (`dart packages get` or `pub get`)
 3. Squash your commits and ensure you have a meaningful commit message.
 4. If you’ve fixed a bug or added code that should be tested, add tests!
-5. Ensure the test suite passes.
+5. Ensure the test suite passes and has 100% coverage.
 6. If you've changed the public API, make sure to update/add documentation.
 7. Format your code (`dart format .`)
-8. Analyze your code (`dart analyze --fatal-infos --fatal-warnings .`)
+8. Analyze your code (`dart analyze --fatal-infos --fatal-warnings lib`)
 9. Create the Pull Request.
 10. Verify that all status checks are passing.
 

README.md

@@ -93,5 +93,15 @@ You can see a live example of it in our mobile game [Domino!](https://flyclops.c
 ## What's next?
 
 - Documentation
-- Tests _([Contributions](https://github.com/Flyclops/tenor_dart/blob/main/CONTRIBUTING.md) welcome)_ ^\_^
 - Further improvements
+
+## Contributing
+
+If you read this far then you are awesome! There are a multiple ways in which you can [contribute](https://github.com/Flyclops/tenor_dart/blob/main/CONTRIBUTING.md):
+
+- Pick up any issue marked with "[good first issue](https://github.com/flyclops/tenor_dart/issues?q=is:open+is:issue+label:%22good+first+issue%22)"
+- Propose any feature, enhancement
+- Report a bug
+- Fix a bug
+- Write and improve some documentation
+- Send in a Pull Request 🙏

ci/codecov

@@ -1,4 +1,6 @@
+rm -rf coverage
 dart test --coverage=./coverage
 dart run coverage:format_coverage -i ./coverage -o ./coverage/lcov.info --lcov --check-ignore --report-on lib/
-genhtml coverage/lcov.info --output=coverage
-open coverage/index.html
+genhtml coverage/lcov.info --output=coverage/output
+open coverage/output/index.html
+# coveralls report coverage/lcov.info --debug --dry-run

example/analysis_options.yaml

@@ -23,6 +23,3 @@ linter:
   rules:
     # avoid_print: false  # Uncomment to disable the `avoid_print` rule
     # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
-
-# Additional information about this file can be found at
-# https://dart.dev/guides/language/analysis-options

example/ios/Runner.xcodeproj/project.pbxproj

@@ -97,7 +97,6 @@
 				985BD1A59394189F91663605 /* Pods-RunnerTests.release.xcconfig */,
 				2FF42CF4104BE4FEAF38558A /* Pods-RunnerTests.profile.xcconfig */,
 			);
-			name = Pods;
 			path = Pods;
 			sourceTree = "<group>";
 		};
@@ -468,6 +467,8 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_IDENTITY = "Apple Development";
+				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
 				DEVELOPMENT_TEAM = N6QNV8K6F2;
 				ENABLE_BITCODE = NO;
@@ -478,6 +479,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = com.example.example;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				PROVISIONING_PROFILE_SPECIFIER = "";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_VERSION = 5.0;
 				VERSIONING_SYSTEM = "apple-generic";
@@ -647,6 +649,8 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_IDENTITY = "Apple Development";
+				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
 				DEVELOPMENT_TEAM = N6QNV8K6F2;
 				ENABLE_BITCODE = NO;
@@ -657,6 +661,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = com.example.example;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				PROVISIONING_PROFILE_SPECIFIER = "";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_VERSION = 5.0;
@@ -670,6 +675,8 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_IDENTITY = "Apple Development";
+				CODE_SIGN_STYLE = Automatic;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
 				DEVELOPMENT_TEAM = N6QNV8K6F2;
 				ENABLE_BITCODE = NO;
@@ -680,6 +687,7 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = com.example.example;
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				PROVISIONING_PROFILE_SPECIFIER = "";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_VERSION = 5.0;
 				VERSIONING_SYSTEM = "apple-generic";

example/lib/main.dart

@@ -173,7 +173,7 @@ class _MyHomePageState extends State<MyHomePage> {
                 Row(
                   children: searchResults.map(
                     (gif) {
-                      final tinygif = gif.media.tinygif;
+                      final tinygif = gif.media.tinyGif;
                       if (tinygif == null) {
                         return const SizedBox();
                       }
@@ -197,7 +197,7 @@ class _MyHomePageState extends State<MyHomePage> {
                 Row(
                   children: featuredResults.map(
                     (gif) {
-                      final tinygif = gif.media.tinygif;
+                      final tinygif = gif.media.tinyGif;
                       if (tinygif == null) {
                         return const SizedBox();
                       }
@@ -222,7 +222,7 @@ class _MyHomePageState extends State<MyHomePage> {
                   mainAxisAlignment: MainAxisAlignment.center,
                   children: postsResults.map(
                     (gif) {
-                      final tinygif = gif.media.tinygif;
+                      final tinygif = gif.media.tinyGif;
                       if (tinygif == null) {
                         return const SizedBox();
                       }
@@ -244,9 +244,9 @@ class _MyHomePageState extends State<MyHomePage> {
                     fontWeight: FontWeight.bold,
                   ),
                 ),
-                if (randomGif?.media.tinygif?.url != null)
+                if (randomGif?.media.tinyGif?.url != null)
                   Image.network(
-                    randomGif!.media.tinygif!.url,
+                    randomGif!.media.tinyGif!.url,
                     fit: BoxFit.cover,
                     height: 50,
                     width: 100,

example/pubspec.yaml

@@ -1,11 +1,10 @@
 name: tenor_dart_example
 description: "An example of how to use Tenor Dart"
 publish_to: "none" # Remove this line if you wish to publish to pub.dev
-
-version: 1.0.0+1
+version: 1.0.0
 
 environment:
-  sdk: ">=3.2.6 <4.0.0"
+  sdk: ">=2.17.0 <4.0.0"
 
 dependencies:
   flutter:

lib/src/constants/media_format.dart

@@ -4,20 +4,20 @@
 class TenorMediaFormat {
   static const String preview = "preview";
   static const String gif = "gif";
-  static const String mediumgif = "mediumgif";
-  static const String tinygif = "tinygif";
-  static const String nanogif = "nanogif";
+  static const String mediumGif = "mediumgif";
+  static const String tinyGif = "tinygif";
+  static const String nanoGif = "nanogif";
   static const String mp4 = "mp4";
-  static const String loopedmp4 = "loopedmp4";
-  static const String tinymp4 = "tinymp4";
-  static const String nanomp4 = "nanomp4";
+  static const String loopedMp4 = "loopedmp4";
+  static const String tinyMp4 = "tinymp4";
+  static const String nanoMp4 = "nanomp4";
   static const String webm = "webm";
-  static const String tinywebm = "tinywebm";
-  static const String nanowebm = "nanowebm";
+  static const String tinyWebm = "tinywebm";
+  static const String nanoWebm = "nanowebm";
   static const String webpTransparent = "webp_transparent";
-  static const String tinywebpTransparent = "tinywebp_transparent";
-  static const String nanowebpTransparent = "nanowebp_transparent";
+  static const String tinyWebpTransparent = "tinywebp_transparent";
+  static const String nanoWebpTransparent = "nanowebp_transparent";
   static const String gifTransparent = "gif_transparent";
-  static const String tinygifTransparent = "tinygif_transparent";
-  static const String nanogifTransparent = "nanogif_transparent";
+  static const String tinyGifTransparent = "tinygif_transparent";
+  static const String nanoGifTransparent = "nanogif_transparent";
 }

lib/src/exceptions/api_exception.dart

@@ -7,6 +7,8 @@ class TenorApiException implements Exception {
     this.message,
   });
 
+  // coverage:ignore-start
   @override
   String toString() => "TenorApiException code: $code, message: $message";
+  // coverage:ignore-end
 }

lib/src/http_client.dart

@@ -0,0 +1,104 @@
+import 'dart:async';
+import 'dart:convert';
+
+import 'package:http/http.dart' as http;
+import 'package:tenor_dart/tenor_dart.dart';
+
+/// A class for handling requests to HTTP.
+///
+/// Needed as a class so it is easier to test/mock.
+class TenorHttpClient {
+  final http.Client? client;
+
+  const TenorHttpClient([
+    this.client,
+  ]);
+
+  http.Client get _client => client ?? http.Client();
+
+// Errors will return error in the body.
+// https://developers.google.com/tenor/guides/response-objects-and-errors
+  Future<Map<String, dynamic>> request(String url, Duration timeout) async {
+    try {
+      final response =
+          await _client.get(Uri.parse(tenorApiUrl + url)).timeout(timeout);
+      // get json
+      final Map<String, dynamic> json = jsonDecode(response.body);
+
+      // if an error is present, throw it
+      if (json['error'] != null ||
+          (response.statusCode != 200 && response.statusCode != 202)) {
+        throw TenorApiException(
+          code: response.statusCode,
+          message: json['error']?['message'],
+        );
+      }
+      // if no error, return the json for consumption
+      return Future.value({
+        ...json,
+        // pass timeout back for fetchNext
+        'timeout': timeout.inMicroseconds,
+      });
+    } on TimeoutException {
+      throw TenorNetworkException();
+    } on http.ClientException catch (e) {
+      if (e.runtimeType.toString() == '_ClientSocketException') {
+        throw TenorNetworkException();
+      }
+      rethrow;
+    } catch (e) {
+      // let the consumer handle it
+      rethrow;
+    }
+  }
+
+  /// Shared functionality between Search and Featured endpoints.
+  Future<TenorResponse?> getGifs(
+    TenorEndpoint endPoint,
+    Duration timeout,
+    String parameters, {
+    int limit = 1,
+    TenorContentFilter? contentFilter,
+    TenorAspectRatioRange? aspectRatioRange,
+    List<String>? mediaFilter,
+    String? pos,
+    bool sticker = false,
+    bool random = false,
+  }) async {
+    var path = endPoint.name + parameters;
+
+    path += '&limit=${limit.clamp(1, 50)}';
+
+    if (sticker) {
+      path += '&searchfilter=sticker';
+    }
+    if (random) {
+      path += '&random=true';
+    }
+    if (contentFilter != null) {
+      path += '&contentfilter=${contentFilter.name}';
+    }
+    if (mediaFilter != null) {
+      path += '&media_filter=${mediaFilter.join(',')}';
+    }
+    if (aspectRatioRange != null) {
+      path += '&ar_range=${aspectRatioRange.name}';
+    }
+    if (pos != null) {
+      path += '&pos=$pos';
+    }
+
+    var data = await request(path, timeout);
+    TenorResponse? res;
+    if (data.isNotEmpty) {
+      res = TenorResponse.fromJson(
+        {
+          ...data,
+          'endpoint': endPoint.name,
+          'parameters': parameters,
+        },
+      );
+    }
+    return res;
+  }
+}

lib/src/models/category.dart

@@ -8,7 +8,6 @@ part 'category.g.dart';
 @JsonSerializable()
 class TenorCategory {
   static const _encoder = JsonEncoder.withIndent('  ');
-  static const _decoder = JsonDecoder();
 
   /// The search term that corresponds to the category. The search term is translated to match the locale of the corresponding request.
   @JsonKey(name: 'searchterm', disallowNullValue: true)
@@ -38,9 +37,8 @@ class TenorCategory {
 
   Map<String, dynamic> toJson() => _$TenorCategoryToJson(this);
 
-  factory TenorCategory.fromString(String message) =>
-      TenorCategory.fromJson(_decoder.convert(message));
-
+  // coverage:ignore-start
   @override
   String toString() => _encoder.convert(toJson());
+  // coverage:ignore-end
 }