Merge pull request #117 from osociety/dev

Preparing release for network_tools

.github/workflows/dart.yml

@@ -8,8 +8,14 @@ name: Dart
 on:
   push:
     branches: [ "main" ]
+    paths: ['network_tools/**']
   pull_request:
     branches: [ "main", "dev" ]
+    paths: ['network_tools/**']
+
+concurrency: 
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
 
 jobs:
   build:
@@ -45,6 +51,4 @@ jobs:
       # want to change this to 'flutter test'.
       - name: Run tests
         run: dart test
-        working-directory: ./network_tools
-
-
+        working-directory: ./network_tools

.github/workflows/flutter.yml

@@ -0,0 +1,71 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Flutter
+
+on:
+  push:
+    branches: [ "main" ]
+    paths: ['network_tools_flutter/**']
+  pull_request:
+    branches: [ "main", "dev-flutter" ]
+    paths: ['network_tools_flutter/**']
+
+concurrency: 
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+        matrix:
+            os: [ubuntu-latest, windows-latest, macos-latest]    
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Java JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: '17'
+      - name: Flutter action
+        uses: subosito/flutter-action@v2.8.0
+        with:
+          channel: stable
+      - name: Flutter version
+        run: flutter --version
+      - name: Cache pubspec dependencies
+        uses: actions/cache@v3.0.7
+        with:
+          path: |
+            ${{ env.FLUTTER_HOME }}/.pub-cache
+            **/.packages
+            **/.flutter-plugins
+            **/.flutter-plugin-dependencies
+            **/.dart_tool/package_config.json
+          key: build-pubspec-${{ hashFiles('**/pubspec.lock') }}
+          restore-keys: |
+            build-pubspec-
+      - name: Cache build runner
+        uses: actions/cache@v2
+        with:
+          path: |
+            **/.dart_tool
+            **/*.g.dart
+            **/*.mocks.dart
+            **/*.config.dart
+          key: build-runner-${{ hashFiles('**/asset_graph.json', '**/*.dart', '**/pubspec.lock', '**/outputs.json') }}
+          restore-keys: |
+            build-runner-
+      - name: Download pub dependencies
+        run: flutter pub get
+        working-directory: ./network_tools_flutter
+      - name: Run analyzer
+        run: flutter analyze
+        working-directory: ./network_tools_flutter
+      - name: Run tests
+        run: flutter test
+        working-directory: ./network_tools_flutter

.github/workflows/publish.yml

@@ -6,7 +6,6 @@ on:
 
 jobs:
   publish:
-
     runs-on: ubuntu-latest
 
     steps:

README.md

@@ -30,51 +30,53 @@ import 'package:network_tools/network_tools.dart';
   // or You can also get address using network_info_plus package
   // final String? address = await (NetworkInfo().getWifiIP());
   final String subnet = address.substring(0, address.lastIndexOf('.'));
-  final stream = HostScanner.discover(subnet, firstHostId: 1, lastHostId: 50,
+  final stream = HostScanner.getAllPingableDevices(subnet, firstHostId: 1, lastHostId: 50,
       progressCallback: (progress) {
     print('Progress for host discovery : $progress');
   });
 
   stream.listen((host) {
     //Same host can be emitted multiple times
     //Use Set<ActiveHost> instead of List<ActiveHost>
-    print('Found device: ${host}');
+    print('Found device: $host');
   }, onDone: () {
     print('Scan completed');
   }); // Don't forget to cancel the stream when not in use.
-
 ```
 
 ### Port Scanner
 
 ```dart
-    //1. Range
-    String target = '192.168.1.1';
-    PortScanner.discover(target, startPort: 1, endPort: 1024,
+  //1. Range
+  String target = '192.168.1.1';
+  PortScanner.scanPortsForSingleDevice(target, startPort: 1, endPort: 1024,
       progressCallback: (progress) {
     print('Progress for port discovery : $progress');
-    }).listen((event) {
-    if (event.isOpen) {
-      print('Found open port : $event');
+  }).listen((ActiveHost event) {
+    if (event.openPorts.isNotEmpty) {
+      print('Found open ports : ${event.openPorts}');
     }
-    }, onDone: () {
+  }, onDone: () {
     print('Scan completed');
-    });
-    //2. Single
-    bool isOpen = PortScanner.isOpen(target,80);
-    //3. Custom
-    PortScanner.customDiscover(target, portList : const [22, 80, 139]);
+  });
+  //2. Single
+  bool isOpen = (await PortScanner.isOpen(target, 80)) == null;
+  //3. Custom
+  PortScanner.customDiscover(target, portList: const [22, 80, 139]);
 ```
 
 ### Mdns Scanner
 
 ```dart
-    for (final ActiveHost activeHost in await MdnsScanner.searchMdnsDevices()) {
-      final MdnsInfo? mdnsInfo = activeHost.mdnsInfo;
-      print(
-        'Address: ${activeHost.address}, Port: ${mdnsInfo!.mdnsPort}, ServiceType: ${mdnsInfo.mdnsServiceType}, MdnsName: ${mdnsInfo.getOnlyTheStartOfMdnsName()}',
-      );
-    }
+  for (final ActiveHost activeHost in await MdnsScanner.searchMdnsDevices()) {
+    final MdnsInfo? mdnsInfo = await activeHost.mdnsInfo;
+    print('''
+    Address: ${activeHost.address}
+    Port: ${mdnsInfo!.mdnsPort}
+    ServiceType: ${mdnsInfo.mdnsServiceType}
+    MdnsName: ${mdnsInfo.getOnlyTheStartOfMdnsName()}
+    ''');
+  }
 ```
 
 ### Run examples

network_tools/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 3.2.2
+
+1. Supporting changes for network_tools_flutter
+
 ## 3.2.1
 
 1. Now GHA runs tests against 3 platforms windows, ubuntu, macos

network_tools/analysis_options.yaml

@@ -12,7 +12,6 @@ analyzer:
     missing_required_param: error
     missing_return: error
     must_be_immutable: error
-    deprecated_member_use_from_same_package: ignore
   exclude:
     - "**/*.g.dart"
     - "**/*.freezed.dart"

network_tools/example/host_scan.dart

@@ -9,6 +9,7 @@ void main() {
       '${DateFormat.Hms().format(record.time)}: ${record.level.name}: ${record.loggerName}: ${record.message}',
     );
   });
+  final log = Logger("host_scan_example");
 
   const String address = '192.168.1.1';
   // or You can also get address using network_info_plus package
@@ -17,7 +18,7 @@ void main() {
 
   // You can set [firstHostId] and scan will start from this host in the network.
   // Similarly set [lastHostId] and scan will end at this host in the network.
-  final stream = HostScanner.getAllPingableDevices(
+  final stream = HostScanner.getAllPingableDevicesAsync(
     subnet,
     // firstHostId: 1,
     // lastHostId: 254,

network_tools/lib/network_tools.dart

@@ -1,3 +1,4 @@
+/// Network tools base library
 library network_tools;
 
 //TODO: add dartdocs
@@ -7,4 +8,5 @@ export 'src/models/active_host.dart';
 export 'src/models/callbacks.dart';
 export 'src/models/mdns_info.dart';
 export 'src/models/open_port.dart';
+export 'src/models/sendable_active_host.dart';
 export 'src/port_scanner.dart';