Skip to content

Commit

Permalink
Rename all centrifuge to spinify
Browse files Browse the repository at this point in the history
  • Loading branch information
PlugFox committed Aug 3, 2023
1 parent d6be690 commit 2b465f2
Show file tree
Hide file tree
Showing 44 changed files with 829 additions and 860 deletions.
10 changes: 5 additions & 5 deletions examples/console/bin/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ void main([List<String>? args]) {
final options = _extractOptions(args ?? const <String>[]);
runZonedGuarded<void>(
() async {
// Create centrifuge client.
// Create Spinify client.
final client = Spinify(
SpinifyConfig(
client: (
name: 'Centrifuge Console Example',
name: 'Spinify Console Example',
version: '0.0.1',
),
getToken: () =>
Expand Down Expand Up @@ -54,7 +54,7 @@ void main([List<String>? args]) {
io.exit(1);
},
zoneValues: {
#dev.plugfox.centrifuge.log: options.verbose,
#dev.plugfox.spinify.log: options.verbose,
},
);
}
Expand All @@ -74,11 +74,11 @@ void main([List<String>? args]) {
))
.parse(args);
final token = result['token']?.toString() ??
io.Platform.environment['CENTRIFUGE_JWT_TOKEN'];
io.Platform.environment['SPINIFY_JWT_TOKEN'];
if (token == null || token.isEmpty || token.split('.').length != 3) {
print('Please provide a valid JWT token as argument with --token option '
'or '
'CENTRIFUGE_JWT_TOKEN environment variable.');
'SPINIFY_JWT_TOKEN environment variable.');
io.exit(1);
}
return (
Expand Down
6 changes: 3 additions & 3 deletions lib/interface.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
library interface;

export 'package:spinify/src/client/centrifuge_interface.dart';
export 'package:spinify/src/client/config.dart';
export 'package:spinify/src/client/spinify_interface.dart';
export 'package:spinify/src/client/state.dart';
export 'package:spinify/src/client/states_stream.dart';
export 'package:spinify/src/model/client_info.dart';
Expand All @@ -11,7 +11,7 @@ export 'package:spinify/src/model/publication.dart';
export 'package:spinify/src/subscription/subscription.dart'
show
ISpinifySubscription,
CentrifugeClientSubscription,
CentrifugeServerSubscription;
SpinifyClientSubscription,
SpinifyServerSubscription;
export 'package:spinify/src/subscription/subscription_config.dart';
export 'package:spinify/src/subscription/subscription_state.dart';
4 changes: 2 additions & 2 deletions lib/spinify.dart
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
library spinify;

export 'package:spinify/src/client/centrifuge.dart' show Spinify;
export 'package:spinify/src/client/config.dart';
export 'package:spinify/src/client/spinify.dart' show Spinify;
export 'package:spinify/src/client/state.dart';
export 'package:spinify/src/client/states_stream.dart';
export 'package:spinify/src/model/client_info.dart';
export 'package:spinify/src/model/exception.dart';
export 'package:spinify/src/model/jwt.dart';
export 'package:spinify/src/model/publication.dart';
export 'package:spinify/src/subscription/subscription.dart'
show CentrifugeClientSubscription, CentrifugeServerSubscription;
show SpinifyClientSubscription, SpinifyServerSubscription;
export 'package:spinify/src/subscription/subscription_config.dart';
export 'package:spinify/src/subscription/subscription_state.dart';
20 changes: 10 additions & 10 deletions lib/src/client/config.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ import 'package:meta/meta.dart';
import 'package:spinify/src/model/pubspec.yaml.g.dart';

/// Token used for authentication
typedef CentrifugeToken = String;
typedef SpinifyToken = String;

/// Callback to get/refresh tokens
/// This callback is used for initial connection
/// and for refreshing expired tokens.
///
/// If method returns null then connection will be established without token.
typedef CentrifugeTokenCallback = FutureOr<CentrifugeToken?> Function();
typedef SpinifyTokenCallback = FutureOr<SpinifyToken?> Function();

/// Callback to get initial connection payload data.
///
/// If method returns null then no payload will be sent at connect time.
typedef CentrifugeConnectionPayloadCallback = FutureOr<List<int>?> Function();
typedef SpinifyConnectionPayloadCallback = FutureOr<List<int>?> Function();

/// {@template centrifuge_config}
/// Centrifuge client common options.
/// {@template spinify_config}
/// Spinify client common options.
///
/// There are several common options available when creating Client instance.
///
Expand All @@ -32,7 +32,7 @@ typedef CentrifugeConnectionPayloadCallback = FutureOr<List<int>?> Function();
/// {@category Entity}
@immutable
final class SpinifyConfig {
/// {@macro centrifuge_config}
/// {@macro spinify_config}
SpinifyConfig({
this.getToken,
this.getPayload,
Expand All @@ -52,21 +52,21 @@ final class SpinifyConfig {

/// Create a default config
///
/// {@macro centrifuge_config}
/// {@macro spinify_config}
factory SpinifyConfig.byDefault() = SpinifyConfig;

/// Callback to get/refresh tokens
/// This callback is used for initial connection
/// and for refreshing expired tokens.
///
/// If method returns null then connection will be established without token.
final CentrifugeTokenCallback? getToken;
final SpinifyTokenCallback? getToken;

/// Callback to get connection payload data.
/// The resulted data send with every connect request.
///
/// If method returns null then no payload will be sent at connect time.
final CentrifugeConnectionPayloadCallback? getPayload;
final SpinifyConnectionPayloadCallback? getPayload;

/// The additional delay between expected server heartbeat pings.
///
Expand Down Expand Up @@ -101,5 +101,5 @@ final class SpinifyConfig {
final Duration timeout;

@override
String toString() => 'CentrifugeConfig{}';
String toString() => 'SpinifyConfig{}';
}
25 changes: 12 additions & 13 deletions lib/src/client/observer.dart
Original file line number Diff line number Diff line change
@@ -1,41 +1,40 @@
import 'package:spinify/src/client/centrifuge_interface.dart';
import 'package:spinify/src/client/spinify_interface.dart';
import 'package:spinify/src/client/state.dart';
import 'package:spinify/src/model/event.dart';
import 'package:spinify/src/model/exception.dart';
import 'package:spinify/src/subscription/subscription.dart';
import 'package:spinify/src/subscription/subscription_state.dart';

/// An interface for observing the behavior of Centrifuge instances.
/// An interface for observing the behavior of Spinify instances.
/// {@category Client}
/// {@subCategory Observer}
abstract class SpinifyObserver {
/// Called whenever a [ISpinify] is instantiated.
void onCreate(ISpinify client) {}

/// Called whenever a [ISpinify] client changes its state
/// to [CentrifugeState$Connecting].
void onConnected(ISpinify client, CentrifugeState$Connected state) {}
/// to [SpinifyState$Connecting].
void onConnected(ISpinify client, SpinifyState$Connected state) {}

/// Called whenever a [ISpinify] client receives a [CentrifugeEvent].
void onEvent(ISpinify client, CentrifugeEvent event) {}
/// Called whenever a [ISpinify] client receives a [SpinifyEvent].
void onEvent(ISpinify client, SpinifyEvent event) {}

/// Called whenever a [ISpinify] client changes its state
/// from [prev] to [next].
void onStateChanged(
ISpinify client, CentrifugeState prev, CentrifugeState next) {}
void onStateChanged(ISpinify client, SpinifyState prev, SpinifyState next) {}

/// Called whenever a [ISpinifySubscription] changes its state
/// from [prev] to [next].
/// Works both for client-side and server-side subscriptions.
void onSubscriptionChanged(ISpinifySubscription subscription,
CentrifugeSubscriptionState prev, CentrifugeSubscriptionState next) {}
SpinifySubscriptionState prev, SpinifySubscriptionState next) {}

/// Called whenever a [ISpinify] client changes its state
/// to [CentrifugeState$Disconnected].
void onDisconnected(ISpinify client, CentrifugeState$Disconnected state) {}
/// to [SpinifyState$Disconnected].
void onDisconnected(ISpinify client, SpinifyState$Disconnected state) {}

/// Called whenever an error is thrown in any Centrifuge client.
void onError(CentrifugeException error, StackTrace stackTrace) {}
/// Called whenever an error is thrown in any Spinify client.
void onError(SpinifyException error, StackTrace stackTrace) {}

/// Called whenever a [ISpinify] is closed.
void onClose(ISpinify client) {}
Expand Down
Loading

0 comments on commit 2b465f2

Please sign in to comment.