Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
968563c
Move Android code to separate folder
JeroenWeener Mar 9, 2023
556a6b4
Copy gradle-wrapper.properties
JeroenWeener Mar 10, 2023
cb85f4a
Register Android implementation in pubspec.yaml
JeroenWeener Mar 10, 2023
6d17da1
Update pubspec.yaml
JeroenWeener Mar 10, 2023
3b1dcdc
Add missing newline to `build.gradle`
JeroenWeener Mar 13, 2023
8f4ffe1
Configure CI to run on stable Flutter version
mvanbeusekom Mar 9, 2023
df9c316
Revert "Add platform interface"
mvanbeusekom Mar 9, 2023
ef76bcf
Move app-facing code to separate folder
JeroenWeener Mar 9, 2023
7959f39
Revert "Merge pull request #35 from Baseflow/revert-34-enhancement/pl…
JeroenWeener Mar 9, 2023
61d77a6
Update CONTRIBUTING.md
JeroenWeener Mar 9, 2023
aecc12e
Move `analysis_options.yaml` to root folder
JeroenWeener Mar 10, 2023
d59ea45
Move Android code to separate folder
JeroenWeener Mar 9, 2023
cf0435b
Copy gradle-wrapper.properties
JeroenWeener Mar 10, 2023
3b2e58e
Register Android implementation in pubspec.yaml
JeroenWeener Mar 10, 2023
de46616
Update pubspec.yaml
JeroenWeener Mar 10, 2023
d2b8639
Update build.gradle
JeroenWeener Mar 13, 2023
bfe99c4
Merge remote-tracking branch 'upstream/main' into enhancement/platfor…
JeroenWeener Mar 13, 2023
2ba97a8
Merge branch 'enhancement/platform-android' of github.com:jeroenweene…
JeroenWeener Mar 13, 2023
af356b4
Remove `example-directory` from google_api_availability_android.yaml
JeroenWeener Mar 13, 2023
029c540
Update google_api_availability_android.yaml
JeroenWeener Mar 13, 2023
fe69b63
Update google_api_availability.yaml
JeroenWeener Mar 13, 2023
ed948fb
Bump `actions/checkout` and `subosito/flutter-action` versions
JeroenWeener Mar 13, 2023
bcc4256
Update google_api_availability.yaml
JeroenWeener Mar 13, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "Merge pull request #35 from Baseflow/revert-34-enhancement/pl…
…atform-interface"

This reverts commit 101bf12, reversing
changes made to d828355.
  • Loading branch information
JeroenWeener committed Mar 13, 2023
commit 7959f390fa918364b835967da564990deb15ca13
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ We really appreciate contributions via GitHub pull requests. To contribute take
* `git checkout upstream/develop -b <name_of_your_branch>`
* Apply your changes
* Verify your changes and fix potential warnings/ errors:
* Check formatting: `flutter format .`
* Run static analyses: `flutter analyzes`
* Check formatting: `dart format .`
* Run static analyses: `flutter analyze`
* Run unit-tests: `flutter test`
* Commit your changes: `git commit -am "<your informative commit message>"`
* Push changes to your fork: `git push origin <name_of_your_branch>`
Expand Down
7 changes: 4 additions & 3 deletions google_api_availability/example/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: google_api_availability_example
description: Demonstrates how to use the google_api_availability plugin.
version: 1.0.0+1
publish_to: none

environment:
sdk: ">=2.15.0 <3.0.0"
Expand All @@ -9,11 +10,11 @@ dependencies:
flutter:
sdk: flutter
cupertino_icons: ^0.1.2

dev_dependencies:
google_api_availability:
path: ../

dev_dependencies:
flutter_lints: 1.0.4

flutter:
uses-material-design: true
uses-material-design: true
3 changes: 3 additions & 0 deletions google_api_availability_platform_interface/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 1.0.0

* Extracts the common platform interface from the google_api_availability package.
21 changes: 21 additions & 0 deletions google_api_availability_platform_interface/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Baseflow

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
42 changes: 42 additions & 0 deletions google_api_availability_platform_interface/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# google_api_availability_platform_interface

[![style: flutter_lints](https://img.shields.io/badge/style-flutter_lints-40c4ff.svg)](https://pub.dev/packages/flutter_lints)

A common platform interface for the [`google_api_availability`][1] plugin.

This interface allows platform-specific implementations of the `google_api_availability`
plugin, as well as the plugin itself, to ensure they are supporting the
same interface. Have a look at the [Federated plugins](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#federated-plugins)
section of the official [Developing packages & plugins](https://flutter.dev/docs/development/packages-and-plugins/developing-packages)
documentation for more information regarding the federated architecture concept.

## Usage

To implement a new platform-specific implementation of `google_api_availability`, extend
[`GoogleApiAvailabilityPlatform`][2] with an implementation that performs the
platform-specific behavior, and when you register your plugin, set the default
`GoogleApiAvailabilityPlatform` by calling
`GoogleApiAvailabilityPlatform.instance = MyGoogleApiAvailabilityPlatform()`.

## Note on breaking changes

Strongly prefer non-breaking changes (such as adding a method to the interface)
over breaking changes for this package.

See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
on why a less-clean interface is preferable to a breaking change.

## Issues

Please file any issues, bugs or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-google-api-availability/issues) page. Commercial support is available, you can contact us at <[email protected]>.

## Want to contribute

If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](../CONTRIBUTING.md) and send us your [pull request](https://github.com/Baseflow/flutter-google-api-availability/pulls).

## Author

This Google API Availability plugin for Flutter is developed by [Baseflow](https://baseflow.com).

[1]: ../google_api_availability
[2]: lib/google_api_availability_platform_interface.dart
10 changes: 10 additions & 0 deletions google_api_availability_platform_interface/analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
include: package:flutter_lints/flutter.yaml

analyzer:
exclude:
# Ignore generated files
- '**/*.g.dart'
- 'lib/src/generated/*.dart'
linter:
rules:
- public_member_api_docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
library google_api_availability_platform_interface;

export 'src/google_api_availability_platform_interface.dart';
export 'src/models/google_play_services_availability.dart';
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import 'package:google_api_availability_platform_interface/google_api_availability_platform_interface.dart';
import 'package:plugin_platform_interface/plugin_platform_interface.dart';

/// The interface that implementations of `google_api_availability` must implement.
///
/// Platform implementations should extend this class rather than implement it
/// as `google_api_availability` does not consider newly added methods to be
/// breaking changes. Extending this class (using `extends`) ensures that the
/// subclass will get the default implementation, while platform implementations
/// that `implements` this interface will be broken by newly added
/// [GoogleApiAvailabilityPlatform] methods.
abstract class GoogleApiAvailabilityPlatform extends PlatformInterface {
/// Constructs a [GoogleApiAvailabilityPlatform].
GoogleApiAvailabilityPlatform() : super(token: _token);

static final Object _token = Object();

static GoogleApiAvailabilityPlatform? _instance;

/// The default instance of [GoogleApiAvailabilityPlatform] to use.
static GoogleApiAvailabilityPlatform? get instance => _instance;

/// Platform-specific plugins should set this with their own platform-specific
/// class that extends [GoogleApiAvailabilityPlatform] when they register
/// themselves.
static set instance(GoogleApiAvailabilityPlatform? instance) {
if (instance == null) {
throw AssertionError(
'Platform interfaces can only be set to a non-null instance');
}

PlatformInterface.verify(instance, _token);
_instance = instance;
}

/// Returns the connection status of Google Play Service.
///
/// Optionally, you can also show an error dialog if the connection status is
/// not [GooglePlayServicesAvailability.success].
Future<GooglePlayServicesAvailability> checkGooglePlayServicesAvailability([
bool showDialogIfNecessary = false,
]) {
throw UnimplementedError(
'checkGooglePlayServicesAvailability() has not been implemented.',
);
}

/// Attempts to make Google Play Services available on this device.
///
/// Shows a dialog if the error is resolvable by user.
/// If the `Future` completes without throwing an exception, Play Services
/// is available on this device.
Future<void> makeGooglePlayServicesAvailable() {
throw UnimplementedError(
'makeGooglePlayServicesAvailable() has not been implemented.',
);
}

/// Returns a human-readable string of the error code.
Future<String> getErrorString() {
throw UnimplementedError(
'getErrorString() has not been implemented.',
);
}

/// Determines whether an error can be resolved via user action.
Future<bool> isUserResolvable() {
throw UnimplementedError(
'isUserResolvable() has not been implemented.',
);
}

/// Displays a notification for an error code, if it is resolvable by the user.
///
/// This method is similar to [showErrorDialogFragment], but is provided for
/// background tasks that cannot or should not display dialogs.
Future<void> showErrorNotification() {
throw UnimplementedError(
'showErrorNotification() has not been implemented.',
);
}

/// Display an error dialog according to the [ErrorCode] if the connection
/// status is not [GooglePlayServicesAvailability.success].
///
/// Returns true if the connection status did not equal
/// [GooglePlayServicesAvailability.success] or any other
/// non-[ConnectionResult] value.
/// Returns false otherwise.
Future<bool> showErrorDialogFragment() {
throw UnimplementedError(
'showErrorDialogFragment() has not been implemented.',
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import 'package:meta/meta.dart';

/// Indicates possible states of the Google Api Services availability.
class GooglePlayServicesAvailability {
const GooglePlayServicesAvailability._(this.value);

/// Returns the value of the status as a string of the given status integer
factory GooglePlayServicesAvailability.byValue(int value) => values[value];

/// Creates an instance of the [GooglePlayServicesAvailability] class. This
/// constructor is exposed for testing purposes only and should not be used
/// by clients of the plugin as it may break or change at any time.
@visibleForTesting
const GooglePlayServicesAvailability.private(this.value);

/// Represents the integer value of the Google Api Services availability
/// state.
final int value;

/// Google Play services are installed on the device and ready to be used.
static const GooglePlayServicesAvailability success =
GooglePlayServicesAvailability._(0);

/// Google Play services is missing on this device.
static const GooglePlayServicesAvailability serviceMissing =
GooglePlayServicesAvailability._(1);

/// Google Play service is currently being updated on this device.
static const GooglePlayServicesAvailability serviceUpdating =
GooglePlayServicesAvailability._(2);

/// The installed version of Google Play services is out of date.
static const GooglePlayServicesAvailability serviceVersionUpdateRequired =
GooglePlayServicesAvailability._(3);

/// The installed version of Google Play services has been disabled on this device.
static const GooglePlayServicesAvailability serviceDisabled =
GooglePlayServicesAvailability._(4);

/// The version of the Google Play services installed on this device is not authentic.
static const GooglePlayServicesAvailability serviceInvalid =
GooglePlayServicesAvailability._(5);

/// Google Play services are not available on this platform.
static const GooglePlayServicesAvailability notAvailableOnPlatform =
GooglePlayServicesAvailability._(6);

/// Unable to determine if Google Play services are installed.
static const GooglePlayServicesAvailability unknown =
GooglePlayServicesAvailability._(7);

/// Returns a list with all possible Google Api Availability states.
static const List<GooglePlayServicesAvailability> values =
<GooglePlayServicesAvailability>[
success,
serviceMissing,
serviceUpdating,
serviceVersionUpdateRequired,
serviceDisabled,
serviceInvalid,
notAvailableOnPlatform,
unknown,
];

static const List<String> _names = <String>[
'success',
'serviceMissing',
'serviceUpdating',
'serviceVersionUpdateRequired',
'serviceDisabled',
'serviceInvalid',
'notAvailableOnPlatform',
'unknown',
];

@override
String toString() => 'GooglePlayServicesAvailability.${_names[value]}';
}
22 changes: 22 additions & 0 deletions google_api_availability_platform_interface/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: google_api_availability_platform_interface
description: A common platform interface for the google_api_availability plugin.
repository: https://github.com/baseflow/flutter-google-api-availability/tree/main/google_api_availability_platform_interface
# NOTE: We strongly prefer non-breaking changes, even at the expense of a
# less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
version: 1.0.0

dependencies:
flutter:
sdk: flutter
plugin_platform_interface: ^2.1.4
meta: ^1.8.0

dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^2.0.1
mockito: ^5.3.2

environment:
sdk: ">=2.15.0 <3.0.0"
flutter: ">=2.8.0"
Loading