Methods Changed

Author: ippo-017

LICENSE

@@ -0,0 +1,158 @@
+<h1 style="text-align:center;">Sense User Activity - Android</h1>
+
+<p style="text-align:center;width:100%;">
+<img width="9%" src="https://custom-icon-badges.demolab.com/github/license/denvercoder1/custom-icon-badges?logo=law"> <img width="12%" src="https://custom-icon-badges.demolab.com/github/last-commit/DenverCoder1/custom-icon-badges?logo=history&logoColor=white"> <img width="9%" src="https://custom-icon-badges.demolab.com/github/actions/workflow/status/DenverCoder1/custom-icon-badges/ci.yml?branch=main&logo=check-circle-fill&logoColor=white"> 
+</p>
+
+<h2 style="text-align:center;">Welcome to Sense's open source repository</h2>
+
+<p style="text-align:center;width:100%;">  
+<img width="4.5%" src="https://custom-icon-badges.demolab.com/badge/Fork-orange.svg?logo=fork"> <img width="4.5%" src="https://custom-icon-badges.demolab.com/badge/Star-yellow.svg?logo=star"> <img width="6.5%" src="https://custom-icon-badges.demolab.com/badge/Commit-green.svg?logo=git-commit&logoColor=fff"> 
+</p>
+
+<p style="text-align:center;"> 
+  
+
+<p style="text-align:center;"> Sense is a client side library that enables you to identify users by pinpointing their hardware and software characteristics. This is done by computing a token that stays consistent in spite of any manipulation.</p>                           
+<p style="text-align:center;"> This tracking method works even in the browser's incognito mode and is not cleared by flushing the cache, closing the browser or restarting the operating system, using a VPN or installing AdBlockers. Sense is available as SenseOS for every open source requirement and is different from Sense PRO, our extremely accurate and detailed product.</p>
+
+
+<p style="text-align:center;"> Sense’s real time demo : https://pro.getsense.co/
+
+*** Try visiting the same page in an incognito mode or switch on the VPN and 
+notice how the visitor identifier remains the same in spite of all these changes!*** 
+
+<h3 style="text-align:center;">Getting started with Sense </h3>
+
+
+## Sense - Android SDK
+
+Sense is a device intelligence and identification tool. This tool collects a comprehensive set of attributes unique to a device or browser, forming an identity that will help businesses.
+Requirements
+
+```
+* Use Android 5.1 (API level 21) and above.
+* Use Kotlin version 1.6.10 and above.
+* Add READ_PHONE_STATE Permission in Android Manifest for deivce information(Optional)
+```
+
+Note: If the application does not have the listed permissions, the values collected using those permissions will be ignored. To provide a valid device details, we recommend employing as much permission as possible based on your use-case.
+
+#### Step 1 - Add Dependency
+
+Add the dependency in the app level build.gradle:
+
+```
+dependencies {
+    implementation 'io.github.sense-opensource:SenseOSUserActivity:0.0.1'
+}
+```
+
+#### Step 2 - Import SDK
+
+```
+import io.github.sense-opensource.SenseOSUserActivity
+
+```
+
+#### Step 3 - Initialize SDK
+
+Add the following line of code to initialize it.
+
+```
+
+SenseOSUserActivity.initSDK(activity)
+
+SenseOSUserActivity.initKeyStrokeBehaviour(context, email, password) // Here email and password are id of EditText Fields
+
+SenseOSUserActivity.initTouchBehaviour(context, touchView) // Here touchView is id of Layout which needs to capture touch metrics
+
+SenseOSUserActivity.initScrollBehaviour(scrollView) // Here scrollView is id of Layout which needs to capture scroll metrics
+
+```
+
+#### Step 4 - Get User Activity Details
+
+Use the below code to get the User Activity Details
+
+```
+Sense.getBehaviourData();
+```
+
+#### Sample Program
+
+Here you can find the demonstration to do the integration.
+
+```
+import io.github.sense-opensource.SenseOSUserActivity
+import io.github.sense-opensource.SenseOSUserActivityConfig
+
+class MainActivity : AppCompatActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_main)
+
+        //Initialize SDK
+        SenseOSUserActivity.initSDK(this)
+
+        val scrollView = view?.findViewById<ScrollView>(R.id.scrollView)
+        val touchView = view?.findViewById<LinearLayout>(R.id.touchView)
+
+        val email = view?.findViewById<EditText>(R.id.public_key)
+        val password = view?.findViewById<EditText>(R.id.secret_key)
+
+        if (email != null && password != null) {
+            SenseOSUserActivity.initKeyStrokeBehaviour(requireContext(), email, password)
+        }
+        if (touchView != null) {
+            SenseOSUserActivity.initTouchBehaviour(requireContext(), touchView)
+        }
+        if (scrollView != null) {
+            SenseOSUserActivity.initScrollBehaviour(scrollView)
+        }
+
+        // Fetch device details
+        getUserActivityDetails();
+    }
+    private fun getUserActivityDetails() {
+        val details = SenseOSUserActivity.getBehaviourData();
+        println(details);
+    }
+}
+```
+
+<h4 style="text-align:center;">Plug and play, in just 3 steps</h3>  
+
+1️⃣ Visit the Git hub repository for the desired function : Validate your desired repository  
+2️⃣ Download the code as a ZIP file : Host/clone the code in your local system or website  
+3️⃣ Run the installer : Start testing the accuracy of your desired metrics 
+
+#### With Sense, you can  
+
+✅ Predict user intent : Identify the good from the bad visitors with precision  
+✅ Create user identities : Tokenise events with a particular user and device  
+✅ Custom risk signals : Developer specific scripts that perform unique functions  
+✅ Protect against Identity spoofing : Prevent users from impersonation  
+✅ Stop device or browser manipulation : Detect user behaviour anomalies 
+
+### Resources 
+
+#### MIT license : 
+
+Sense OS is available under the <a href="https://github.com/sense-opensource/sense-device-identity-android/blob/main/LICENSE"> MIT license </a>
+
+#### Contributors code of conduct : 
+
+Thank you for your interest in contributing to this project! We welcome all contributions and are excited to have you join our community. Please read these <a href="https://github.com/sense-opensource/sense-device-identity-android/blob/main/code_of_conduct.md"> code of conduct </a> to ensure a smooth collaboration.
+
+#### Where you can get support :     
+![Gmail](https://img.shields.io/badge/Gmail-D14836?logo=gmail&logoColor=white)       product@getsense.co 
+
+Public Support:
+For questions, bug reports, or feature requests, please use the Issues and Discussions sections on our repository. This helps the entire community benefit from shared knowledge and solutions.
+
+Community Chat:
+Join our Discord server (link) to connect with other developers, ask questions in real-time, and share your feedback on Sense.
+
+Interested in contributing to Sense?
+Please review our <a href="https://github.com/sense-opensource/sense-device-identity-android/blob/main/CONTRIBUTING.md"> Contribution Guidelines </a> to learn how to get started, submit pull requests, or run the project locally. We encourage you to read these guidelines carefully before making any contributions. Your input helps us make Sense better for everyone!

README.md

@@ -0,0 +1,42 @@
+#built application files
+*.apk
+*.ap_
+
+# files for the dex VM
+*.dex
+
+# Java class files
+*.class
+
+# generated files
+bin/
+gen/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Windows thumbnail db
+Thumbs.db
+
+# OSX files
+.DS_Store
+
+# Eclipse project files
+.classpath
+.project
+
+# Android Studio
+*.iml
+.idea/
+#.idea/workspace.xml - remove # and delete .idea if it better suit your needs.
+.gradle/
+build/
+
+app/build/
+
+gradle/
+
+#NDK
+obj/
+
+gradlew

app/.gitignore

@@ -0,0 +1,67 @@
+plugins {
+    id 'com.android.application'
+    id 'org.jetbrains.kotlin.android'
+}
+
+android {
+    compileSdk 34
+
+    defaultConfig {
+        applicationId "com.getsense"
+        minSdk 21
+        targetSdk 34
+        versionCode 1
+        versionName "1.0"
+
+        buildFeatures {
+            dataBinding true
+        }
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+        debug {
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_11
+        targetCompatibility JavaVersion.VERSION_11
+    }
+    kotlinOptions {
+        jvmTarget = '11'
+    }
+    namespace 'com.getsense'
+}
+
+dependencies {
+
+    implementation 'androidx.core:core-ktx:1.13.1'
+    implementation 'androidx.appcompat:appcompat:1.7.0'
+    implementation 'com.google.android.material:material:1.6.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
+    implementation 'androidx.compose.ui:ui-graphics-android:1.7.4'
+    implementation 'androidx.compose.material3:material3-android:1.3.0'
+    implementation 'androidx.compose.foundation:foundation-android:1.7.4'
+    implementation 'androidx.compose.runtime:runtime-android:1.7.4'
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.ext:junit:1.2.1'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
+    implementation project(path: ':sense')
+    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
+    implementation 'com.squareup.retrofit2:converter-jackson:2.9.0' // Use Jackson or Gson for JSON parsing
+    implementation 'com.squareup.okhttp3:okhttp:4.10.0'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.15.2'
+    implementation 'com.google.code.gson:gson:2.10.1' // Use the latest version
+    implementation 'com.squareup.okhttp3:logging-interceptor:5.0.0-alpha.2'
+    implementation 'com.squareup.retrofit2:converter-gson:2.11.0'
+    implementation("androidx.activity:activity-ktx:1.6.1")
+    implementation("androidx.fragment:fragment-ktx:1.5.6")
+
+}

app/build.gradle

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+<!--    <queries>-->
+<!--        &lt;!&ndash; Allows querying for installed apps &ndash;&gt;-->
+<!--        <package android:name="com.android.vending" />-->
+<!--    </queries>-->
+    <uses-permission android:name="android.permission.INTERNET" />
+    <!--     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+      <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+          <uses-permission android:name="android.permission.READ_PHONE_NUMBERS" />
+      <uses-permission android:name="android.permission.GET_ACCOUNTS" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+
+
+       <uses-permission android:name="android.permission.PACKAGE_USAGE_STATS" tools:ignore="ProtectedPermissions" />
+     <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"
+         tools:ignore="QueryAllPackagesPermission" /> -->
+
+     <application
+       android:dataExtractionRules="@xml/data_extraction_rules"
+       android:fullBackupContent="@xml/backup_rules"
+       android:enableOnBackInvokedCallback="true"
+       android:icon="@mipmap/ic_launcher"
+       android:label="@string/app_name"
+       android:roundIcon="@mipmap/ic_launcher_round"
+       android:supportsRtl="true"
+       android:theme="@style/Theme.SenseSDK"
+       tools:targetApi="31">
+       <activity
+           android:name="com.getsense.MainActivity"
+           android:exported="true">
+           <intent-filter>
+               <action android:name="android.intent.action.MAIN" />
+
+               <category android:name="android.intent.category.LAUNCHER" />
+           </intent-filter>
+       </activity>
+   </application>
+
+ </manifest>