Language is now a String rather than enum. iTunes largely ignores lan…

…guage; PodcastIndex uses it for trending.

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.8
+
+- BREAKING CHANGE: Language is now a text parameter (2-3 letter code) rather than enum. This is because iTunes largely ignores language, but PodcastIndex can use it for trending podcasts.
+
 ## 0.6.7
 
 - Update example to handle null feed.

lib/podcast_search.dart

@@ -11,7 +11,6 @@ export 'src/model/genre.dart';
 export 'src/model/value.dart';
 export 'src/model/funding.dart';
 export 'src/model/item.dart';
-export 'src/model/language.dart';
 export 'src/model/podcast.dart';
 export 'src/model/search_result.dart';
 export 'src/model/transcript.dart';

lib/src/search/base_search.dart

@@ -19,7 +19,7 @@ abstract class BaseSearch {
     required String term,
     Country country = Country.none,
     Attribute attribute = Attribute.none,
-    Language language = Language.none,
+    String language = '',
     int limit = 0,
     int version = 0,
     bool explicit = false,

lib/src/search/itunes_search.dart

@@ -55,7 +55,7 @@ final class ITunesSearch extends BaseSearch {
   int? _limit;
 
   /// If non-null, the results will be limited to the language specified.
-  late Language _language;
+  late String _language;
 
   /// Set to true to disable the explicit filter.
   bool? _explicit;
@@ -93,7 +93,7 @@ final class ITunesSearch extends BaseSearch {
       {String? term,
       Country country = Country.none,
       Attribute attribute = Attribute.none,
-      Language language = Language.none,
+      String language = '',
       int limit = 0,
       int version = 0,
       bool explicit = false,
@@ -269,7 +269,7 @@ final class ITunesSearch extends BaseSearch {
   }
 
   String _languageParam() {
-    return _language != Language.none ? '&language=${_language.code}' : '';
+    return _language.isNotEmpty && _language == 'ja' ? '&language=ja_jp' : '';
   }
 
   String _versionParam() {

lib/src/search/podcast_index_search.dart

@@ -202,15 +202,16 @@ final class PodcastIndexSearch extends BaseSearch {
   /// By default, searches will be based on keywords. Supply an [Attribute]
   /// value to search by a different attribute such as Author, genre etc.
   @override
-  Future<SearchResult> search(
-      {String? term,
-      Country country = Country.none,
-      Attribute attribute = Attribute.none,
-      Language language = Language.none,
-      int limit = 0,
-      int version = 0,
-      bool explicit = false,
-      Map<String, dynamic>? queryParams = const {}}) async {
+  Future<SearchResult> search({
+    String? term,
+    Country country = Country.none,
+    Attribute attribute = Attribute.none,
+    String language = '',
+    int limit = 0,
+    int version = 0,
+    bool explicit = false,
+    Map<String, dynamic>? queryParams = const {},
+  }) async {
     _term = term;
     _limit = limit;
     _explicit = explicit;
@@ -238,19 +239,29 @@ final class PodcastIndexSearch extends BaseSearch {
   /// the infrequent update of the chart feed it is recommended that clients
   /// cache the results.
   @override
-  Future<SearchResult> charts(
-      {Country country = Country.none,
-      int limit = 20,
-      bool explicit = false,
-      String genre = '',
-      Map<String, dynamic> queryParams = const {}}) async {
+  Future<SearchResult> charts({
+    Country country = Country.none,
+    String language = '',
+    int limit = 20,
+    bool explicit = false,
+    String genre = '',
+    Map<String, dynamic> queryParams = const {},
+  }) async {
     try {
+      var queryParameters = <String, dynamic>{
+        'since': -1 * 3600 * 24 * 7,
+        'cat': genre,
+        'max': limit,
+      };
+
+      if (language.isNotEmpty) {
+        queryParameters.addAll({'lang': language});
+      }
+
+      queryParameters.addAll(queryParams);
+
       var response = await _client.get(trendingApiEndpoint,
-          queryParameters: {
-            'since': -1 * 3600 * 24 * 7,
-            'cat': genre,
-            'max': limit,
-          }..addAll(queryParams));
+          queryParameters: queryParameters);
 
       return SearchResult.fromJson(
           json: response.data, type: ResultType.podcastIndex);

lib/src/search/search.dart

@@ -26,7 +26,7 @@ class Search {
   int _limit = 0;
 
   /// If non-null, the results will be limited to the language specified.
-  Language _language = Language.none;
+  String _language = '';
 
   /// Set to true to disable the explicit filter.
   bool _explicit = false;
@@ -54,7 +54,7 @@ class Search {
     String term, {
     Country country = Country.none,
     Attribute attribute = Attribute.none,
-    Language language = Language.none,
+    String language = '',
     int limit = 0,
     int version = 0,
     bool explicit = false,
@@ -101,12 +101,14 @@ class Search {
   /// cache the results.
   Future<SearchResult> charts({
     Country country = Country.none,
+    String language = '',
     int limit = 20,
     bool explicit = false,
     String genre = '',
     Map<String, dynamic> queryParams = const {},
   }) async {
     _country = country;
+    _language = language;
     _limit = limit;
     _explicit = explicit;
     _genre = genre;
@@ -118,6 +120,7 @@ class Search {
         podcastIndexProvider: searchProvider as PodcastIndexProvider,
       ).charts(
         country: _country,
+        language: _language,
         limit: _limit,
         explicit: _explicit,
         genre: _genre,

pubspec.yaml

@@ -1,7 +1,7 @@
 name: podcast_search
 description: A library for searching for podcasts and parsing podcast RSS feeds. Supports iTunes and PodcastIndex directories, and newer features such as chapters and transcripts.
 
-version: 0.6.7
+version: 0.6.8
 homepage: https://github.com/amugofjava/podcast_search
 
 environment: