Merge pull request #44 from GetStream/rename-client

Author: xsahil03x

example/lib/main.dart

@@ -9,7 +9,7 @@ void main() {
   WidgetsFlutterBinding.ensureInitialized();
   final _key = String.fromEnvironment('key');
   final _secret = String.fromEnvironment('secret');
-  final client = StreamClient.connect(_key, secret: _secret);
+  final client = StreamFeedClient.connect(_key, secret: _secret);
   runApp(
     MyApp(
       client: client,
@@ -19,7 +19,7 @@ void main() {
 
 class MyApp extends StatelessWidget {
   const MyApp({Key? key, required this.client}) : super(key: key);
-  final StreamClient client;
+  final StreamFeedClient client;
 
   @override
   Widget build(BuildContext context) {

example/lib/profile_screen.dart

@@ -17,7 +17,7 @@ class ProfileScreen extends StatefulWidget {
 }
 
 class _ProfileScreenState extends State<ProfileScreen> {
-  late StreamClient _client;
+  late StreamFeedClient _client;
   bool _isLoading = true;
 
   List<Activity> activities = <Activity>[];

example/lib/timeline_screen.dart

@@ -14,7 +14,7 @@ class TimelineScreen extends StatefulWidget {
 }
 
 class _TimelineScreenState extends State<TimelineScreen> {
-  late StreamClient _client;
+  late StreamFeedClient _client;
   bool _isLoading = true;
   List<Activity> activities = <Activity>[];
 

example/lib/utils/utils.dart

@@ -8,7 +8,7 @@ class ClientProvider extends InheritedWidget {
     required Widget child,
   }) : super(key: key, child: child);
 
-  final StreamClient client;
+  final StreamFeedClient client;
 
   static ClientProvider? of(BuildContext context) {
     return context.dependOnInheritedWidgetOfExactType<ClientProvider>();
@@ -21,5 +21,5 @@ class ClientProvider extends InheritedWidget {
 }
 
 extension ProviderX on BuildContext {
-  StreamClient get client => ClientProvider.of(this)!.client;
+  StreamFeedClient get client => ClientProvider.of(this)!.client;
 }

packages/stream_feed/lib/src/client/index.dart

@@ -1,2 +1,2 @@
 export 'analytics_client.dart';
-export 'stream_client.dart';
+export 'stream_feed_client.dart';

packages/stream_feed/lib/src/client/stream_client.dart renamed to packages/stream_feed/lib/src/client/stream_feed_client.dart

@@ -12,26 +12,26 @@ import 'package:stream_feed/src/core/index.dart';
 
 import 'package:stream_feed/src/client/reactions_client.dart';
 import 'package:stream_feed/src/client/user_client.dart';
-import 'package:stream_feed/src/client/stream_client_impl.dart';
+import 'package:stream_feed/src/client/stream_feed_client_impl.dart';
 
-/// Different sides on which you can run this [StreamClient] on
+/// Different sides on which you can run this [StreamFeedClient] on
 enum Runner {
-  /// Marks the [StreamClient] that it is currently running on server-side
+  /// Marks the [StreamFeedClient] that it is currently running on server-side
   server,
 
-  /// Marks the [StreamClient] that it is currently running on client-side
+  /// Marks the [StreamFeedClient] that it is currently running on client-side
   client,
 }
 
 /// The client class that manages API calls and authentication
 /// To instantiate the client you need an API key and secret.
 /// You can find the key and secret on the dashboard.
-abstract class StreamClient {
+abstract class StreamFeedClient {
   /// If you want to use the API client directly on your web/mobile app
   /// you need to generate a user token server-side and pass it.
   ///
   ///
-  /// - Instantiate a new client (server side) with [StreamClient.connect]
+  /// - Instantiate a new client (server side) with [StreamFeedClient.connect]
   /// using your api [secret] parameter and [apiKey]
   /// ```dart
   /// var client = connect('YOUR_API_KEY',secret: 'API_KEY_SECRET');
@@ -41,20 +41,20 @@ abstract class StreamClient {
   /// var userToken = client.frontendToken('the-user-id');
   /// ```
   /// - if you are using the SDK client side, get a userToken in your dashboard
-  /// and pass it to [StreamClient.connect] using the [token] parameter
+  /// and pass it to [StreamFeedClient.connect] using the [token] parameter
   /// and [apiKey]
   /// ```dart
   /// var client = connect('YOUR_API_KEY',token: Token('userToken'));
   /// ```
-  factory StreamClient.connect(
+  factory StreamFeedClient.connect(
     String apiKey, {
     Token? token,
     String? secret,
     String? appId,
     StreamHttpClientOptions? options,
     Runner runner = Runner.client,
   }) =>
-      StreamClientImpl(
+      StreamFeedClientImpl(
         apiKey,
         userToken: token,
         secret: secret,

packages/stream_feed/lib/src/client/stream_client_impl.dart renamed to packages/stream_feed/lib/src/client/stream_feed_client_impl.dart

@@ -18,7 +18,7 @@ import 'package:stream_feed/src/core/index.dart';
 import 'package:stream_feed/src/core/models/feed_id.dart';
 
 import 'package:stream_feed/src/client/user_client.dart';
-import 'package:stream_feed/src/client/stream_client.dart';
+import 'package:stream_feed/src/client/stream_feed_client.dart';
 import 'package:stream_feed/src/core/util/extension.dart';
 import 'package:stream_feed/src/core/util/token_helper.dart';
 import 'package:logging/logging.dart';
@@ -34,9 +34,9 @@ final _levelEmojiMapper = {
 };
 
 // ignore: public_member_api_docs
-class StreamClientImpl implements StreamClient {
-  /// [StreamClientImpl] constructor
-  StreamClientImpl(
+class StreamFeedClientImpl implements StreamFeedClient {
+  /// [StreamFeedClientImpl] constructor
+  StreamFeedClientImpl(
     this.apiKey, {
     this.secret,
     this.userToken,

packages/stream_feed/test/faye_client_test.dart

@@ -1,7 +1,7 @@
 import 'dart:io';
 
-import 'package:stream_feed/src/client/stream_client.dart';
-import 'package:stream_feed/src/client/stream_client_impl.dart';
+import 'package:stream_feed/src/client/stream_feed_client.dart';
+import 'package:stream_feed/src/client/stream_feed_client_impl.dart';
 import 'package:stream_feed/src/core/models/feed_id.dart';
 import 'package:stream_feed/src/core/models/realtime_message.dart';
 import 'package:stream_feed/stream_feed.dart';
@@ -14,7 +14,7 @@ void main() async {
     final appId = env['appId'];
     final apiKey = env['apiKey'];
 
-    final client = StreamClient.connect(
+    final client = StreamFeedClient.connect(
       apiKey!,
       secret: secret,
       appId: appId,

packages/stream_feed/test/stream_client_test.dart renamed to packages/stream_feed/test/stream_feed_client_test.dart

@@ -2,7 +2,7 @@ import 'package:mocktail/mocktail.dart';
 import 'package:stream_feed/src/core/util/token_helper.dart';
 import 'package:stream_feed/stream_feed.dart';
 import 'package:test/test.dart';
-import 'package:stream_feed/src/client/stream_client_impl.dart';
+import 'package:stream_feed/src/client/stream_feed_client_impl.dart';
 
 import 'mock.dart';
 import 'utils.dart';
@@ -12,7 +12,7 @@ void main() {
     group('throw', () {
       test('throws an AssertionError when no secret or token provided', () {
         expect(
-          () => StreamClient.connect('apiKey'),
+          () => StreamFeedClient.connect('apiKey'),
           throwsA(
             predicate<AssertionError>((e) =>
                 e.message == 'At least a secret or userToken must be provided'),
@@ -25,7 +25,7 @@ void main() {
         'while running on client-side',
         () {
           expect(
-            () => StreamClient.connect('apiKey', secret: 'secret'),
+            () => StreamFeedClient.connect('apiKey', secret: 'secret'),
             throwsA(
               predicate<AssertionError>(
                 (e) =>
@@ -42,7 +42,7 @@ void main() {
         'while running on server-side',
         () {
           expect(
-            () => StreamClient.connect(
+            () => StreamFeedClient.connect(
               'apiKey',
               token: TokenHelper.buildFrontendToken('secret', 'userId'),
               runner: Runner.server,
@@ -63,7 +63,7 @@ void main() {
         'while running on client-side',
         () {
           expect(
-            () => StreamClient.connect(
+            () => StreamFeedClient.connect(
               'apiKey',
               secret: 'secret',
               token: TokenHelper.buildFrontendToken('secret', 'userId'),
@@ -82,11 +82,12 @@ void main() {
       );
 
       test("don't throw if secret provided while running on server-side", () {
-        StreamClient.connect('apiKey', secret: 'secret', runner: Runner.server);
+        StreamFeedClient.connect('apiKey',
+            secret: 'secret', runner: Runner.server);
       });
 
       test("don't throw if token provided while running on client-side", () {
-        StreamClient.connect(
+        StreamFeedClient.connect(
           'apiKey',
           token: TokenHelper.buildFrontendToken('secret', 'userId'),
         );
@@ -96,7 +97,7 @@ void main() {
       const secret = 'secret';
       const userId = 'userId';
       final client =
-          StreamClientImpl('apiKey', secret: secret, runner: Runner.server);
+          StreamFeedClientImpl('apiKey', secret: secret, runner: Runner.server);
       expect(client.collections, isNotNull);
       expect(client.batch, isNotNull);
       expect(client.aggregatedFeed('slug', 'userId'), isNotNull);
@@ -113,7 +114,8 @@ void main() {
       final mockApi = MockAPI();
       when(() => mockApi.users).thenReturn(MockUserAPI());
       final token = TokenHelper.buildFrontendToken('secret', 'userId');
-      final client = StreamClientImpl('apiKey', userToken: token, api: mockApi);
+      final client =
+          StreamFeedClientImpl('apiKey', userToken: token, api: mockApi);
 
       const targetUrl = 'targetUrl';