issue116, issue127-130, and issue 133 - Add Android P support, sample…

… app, add RoboElectric; Update documentation; Bug and crash fixes
isuPatches · May 12, 2019 · a0c589d · a0c589d
1 parent dcbad2c
commit a0c589d
Show file tree

Hide file tree

Showing 197 changed files with 8,294 additions and 2,044 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -6,6 +6,8 @@ about: Create a report to help us improve
 
 Thank you for creating an issue to improve this library! Please check Please check [the current issues](https://github.com/isuPatches/WiseFy/issues) to make sure that the improvement isn't already being worked on.
 
+It will be _EXTREMELY_ helpful if you also take a look at the [sample app](/wisefysample) to see how it behalves and if you can reproduce there.
+
 **Description**
 A clear and concise description of the bug.
 
@@ -27,10 +29,13 @@ A description of what you expected to happen.
 **Actual behavior**
 A description of what actually happened 
 
-**Android Information**
+**Additional Information**
  - Device (i.e. Nexus 5x):
  - OS Version (i.e. Android 8.1):
-- Rooted:
+ - Rooted:
+ - Using legacy connection logic?:
+ - Using legacy search logic?:
+ - Reproducible with sample app?:
 
 **Logs**
 Please include logs from WiseFy if at all possible.  They can be found with `logging(true)` set on the WiseFy instance and by filtering on 'WiseFy'
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,9 @@
 *.iml
 .gradle
 /local.properties
-/.idea
 /build
-.DS_Store
+.DS_Store
+
+/.idea/*.xml
+/.idea/caches/*
+/.idea/libraries/*
diff --git a/.idea/dictionaries/patches.xml b/.idea/dictionaries/patches.xml
diff --git a/.travis.yml b/.travis.yml
@@ -8,30 +8,19 @@ env:
   global:
     - TARGET_SDK=28
     - BUILD_TOOLS_VERSION=28.0.3
-  matrix:
-    - EMULATOR_SDK=android-19 ABI=armeabi-v7a
-    - EMULATOR_SDK=android-22 ABI=armeabi-v7a
 
 android:
   components:
     - tools
     - platform-tools
     - tools
     - android-${TARGET_SDK}
-    - android-19
-    - android-22
     - build-tools-${BUILD_TOOLS_VERSION}
+    - extra-google-m2repository
     - extra-android-m2repository
 
-before_script:
-  - android-update-sdk --components=sys-img-$ABI-$EMULATOR_SDK --accept-licenses='android-sdk-license-[0-9a-f]{8}'
-  - echo no | android create avd --force -n test -t $EMULATOR_SDK --abi $ABI
-  - emulator -avd test -no-audio -no-window &
-  - ./gradlew clean assembleDebug assembleDebugAndroidTest
-  - android-wait-for-emulator
-  - adb shell input keyevent 82 &
-
 script:
+  - ./gradlew clean assembleDebug assembleDebugAndroidTest
   - travis_wait 60 ./gradlew makeGoodChoices
 
 after_success:

diff --git a/CHANGE.md b/CHANGE.md
@@ -6,4 +6,6 @@ WiseFy upon each new major release will start a brand new change log.
 
 [2.x Changes](/changes/2.x.md)
 
-[3.x Changes](/changes/3.x.md)
+[3.x Changes](/changes/3.x.md)
+
+[3.x Changes](/changes/4.x.md)
diff --git a/README.md b/README.md
@@ -3,48 +3,44 @@
 Wifi configuration and util library built for Android.  
 
 > <br/>*Developed by Patches 04/24/2016 - present* <br/>
-> <br/> Logo/icon created by mansya (2018)<br/>
-> <br/>Supports Android SDK levels 16-27<br/><br/>
+> <br/>Logo/icon created by mansya (2018)<br/>
+> <br/>Supports Android SDK levels 16-28<br/><br/>
 
 [![Build Status](https://travis-ci.org/isuPatches/WiseFy.svg?branch=master)](https://travis-ci.org/isuPatches/WiseFy) [ ![Download](https://api.bintray.com/packages/isupatches/Maven/wisefy/images/download.svg) ](https://bintray.com/isupatches/Maven/wisefy/_latestVersion) [![codecov](https://codecov.io/gh/isuPatches/WiseFy/branch/3.x/graph/badge.svg)](https://codecov.io/gh/isuPatches/WiseFy)
 
 [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-WiseFy-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/6011) [![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23230-blue.svg)](http://androidweekly.net/issues/issue-230) 
 
-## What's New in 3.x
-
-- Rewritten in Kotlin
-    - Static analysis tools added
-- Ability to get the IP of a device
-- Additional details in callbacks for adding a network:
-    - The new id of the network
-    - The WifiConfiguration of the network that was added
-- isNetworkInConfigurationList renamed isNetworkSaved
-- brains renamed Brains
-- Nullability issues will be more visible
-- Definitions for NetworkTypes and WiseFyCodes
-- Immutability throughout the library
-- Improved architecture
-- Updated dependencies
-- Updated to Gradle 4.x and AGP 3.x
-- Target now is set to API 27
-- Less duplicate code
-- Improved testing
-- Updated documentation with new Kotlin examples
-- Other improvements and adjustments!
-
-## What's New in 2.0.x
-
-- Asynchronous API
-    - Certain methods have callbacks and are run on a WiseFy specific background thread
-- Ability to search by regex for:
-    - Nearby access points
-    - Saved Configurations
-    - SSIDs
-- Ability to query for RSSI
-- Ability to query for if the device is roaming
-- Additional methods to query for network security
-- Full fledged documentation directory
-- Tested against Android O
+## What's New in 4.x
+
+- Android P Support
+    - New isDeviceRoaming logic
+- New logic for SDK 23 and above
+    - WiseFySearch rewritten to remove deprecated APIs from Android OS
+    - WiseFyConnection rewritten to remove deprecated APIs from Android OS
+    - Ability to use legacy search logic
+    - Ability to use legacy connection logic
+- Update to Android X
+- Improved annotations for required permissions
+- Update to gradle 5.x
+- Static analysis tools updated
+- WEP is now deprecated due to security and other issues with this network type and will be phased out
+- Introduction of [RoboElectric](https://github.com/robolectric/robolectric) for better unit testing
+    - This may be controversial, but please check this [issue](https://github.com/isuPatches/WiseFy/issues/133) for rationale
+- Removal of Checkstyle and FindBugs since project is no longer Java
+- Removal of GCM support due to GCM being sunset
+- New [sample app](/wisefysample) included as part of the repo
+    - This replaces the previous permissions example
+- Crash fixes for:
+    - Async api with null current network
+    - Async api with null current network info
+    - Async api with null nearby access points
+- Fix for searching when empty list returned from OS
+- More tests
+- Removal of some generic variable names from documentation for clarity
+
+Previous updates:
+- [What's New in 3.x](/changes/whatsnew/3.x.md)
+- [What's New in 2.x](/changes/whatsnew/2.x.md)
 
 ## Adding to your project
 
@@ -125,6 +121,8 @@ _With Java_
 WiseFy wisefy = new WiseFy.Brains(getActivity()).logging(true).getSmarts();
 ```
 
+By default, legacy logic is disabled on devices with SDK 23 or higher.  If you want to use or test against the legacy search or connection logic, please see: [Using Legacy Classes And Logic](/documentation/using_legacy_classes_and_logic.md).
+
 ## Cleanup
 
 Since the Async API of WiseFy is run on a background thread, it is necessary to make sure it is exited and cleanup up properly.
@@ -134,7 +132,7 @@ To stop the WiseFy thread and nullify it along with it's handler please call:
 _With Kotlin_
 
 ```kotlin
-wisefy.dump();
+wisefy.dump()
 ```
 
 _With Java_
@@ -160,14 +158,14 @@ For the sake of transparency and because you're probably curious as to what perm
 
 If access points or SSIDs are not being returned on >= 6.x devices but there are visible networks, it's most likely because you haven't asked in your application for the `Manifest.permission.ACCESS_COARSE_LOCATION` permission which is what allows us to see the access points nearby. This permission request will not be added to the WiseFy library to reduce package bloat and so users can determine their own UI/UX.
 
-Please check [the permssions example](/documentation/permissions_example.md) for a sample of how to request permissions for WiseFy.
+Please check [the sample app](/wisefysample) for an example of how to request permissions for WiseFy.
 
 ## Usage
 
 Please check [the documentation markdown directory](/documentation) for usage examples and details about both the synchronous and asynchronous API.
 
 ## License ##
-Copyright 2018 Patches Klinefelter
+Copyright 2019 Patches Klinefelter
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 compliance with the License. You may obtain a copy of the License at

diff --git a/build.gradle b/build.gradle
@@ -2,18 +2,19 @@ buildscript {
     project.ext {
         agp_version = '3.4.0'
         bintray_version = '1.8.4'
-        cpd_version = '1.3'
+        cpd_version = '2.0-SNAPSHOT'
         dokka_version = '0.9.18'
         dexcount_version = '0.8.5'
         jacoco_version = '0.8.3'
-        kotlin_version = "1.3.30"
+        kotlin_version = "1.3.31"
         maven_version = '2.1'
     }
 
     repositories {
         jcenter()
         google()
         maven { url "https://plugins.gradle.org/m2/" }
+        maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
     }
 
     dependencies {
@@ -140,7 +141,7 @@ task makeGoodChoices {
 
     outputs.upToDateWhen { false }
 
-    dependsOn 'staticAnalysisSanityCheck', 'jacocoAllCombinedTests'
+    dependsOn 'staticAnalysisSanityCheck', ':wisefy:jacocoDebugUnitTest'
     doLast {
         println "\n#############################################" +
                 "\n# All checks passed! You are doing so good! #" +

diff --git a/changes/4.x.md b/changes/4.x.md
@@ -0,0 +1 @@
+## v4.0.0 - 05/x/2019
diff --git a/changes/whatsnew/2.x.md b/changes/whatsnew/2.x.md
@@ -0,0 +1,13 @@
+## What's New in 2.0.x
+
+- Asynchronous API
+    - Certain methods have callbacks and are run on a WiseFy specific background thread
+- Ability to search by regex for:
+    - Nearby access points
+    - Saved Configurations
+    - SSIDs
+- Ability to query for RSSI
+- Ability to query for if the device is roaming
+- Additional methods to query for network security
+- Full fledged documentation directory
+- Tested against Android O
diff --git a/changes/whatsnew/3.x.md b/changes/whatsnew/3.x.md
@@ -0,0 +1,21 @@
+## What's New in 3.x
+
+- Rewritten in Kotlin
+    - Static analysis tools added
+- Ability to get the IP of a device
+- Additional details in callbacks for adding a network:
+    - The new id of the network
+    - The WifiConfiguration of the network that was added
+- isNetworkInConfigurationList renamed isNetworkSaved
+- brains renamed Brains
+- Nullability issues will be more visible
+- Definitions for NetworkTypes and WiseFyCodes
+- Immutability throughout the library
+- Improved architecture
+- Updated dependencies
+- Updated to Gradle 4.x and AGP 3.x
+- Target now is set to API 27
+- Less duplicate code
+- Improved testing
+- Updated documentation with new Kotlin examples
+- Other improvements and adjustments!
diff --git a/config/detekt-config.yml b/config/detekt-config.yml
@@ -61,7 +61,7 @@ complexity:
     ignoreDefaultParameters: false
   LongMethod:
     active: true
-    threshold: 20
+    threshold: 50
   LargeClass:
     active: true
     threshold: 150
@@ -83,7 +83,7 @@ complexity:
     threshold: 5
   NestedBlockDepth:
     active: true
-    threshold: 5
+    threshold: 6
   TooManyFunctions:
     active: true
     thresholdInFiles: 50