Merge pull request #7 from logicwind/dev

Added auth-token in createTracker

Author: bhavesh-lw

README.md

@@ -55,10 +55,16 @@ trackMediaEvent
 
 ### createTracker()
 
-The createTracker function is used to instantiate a tracker object for Matomo analytics within a React Native application .It will take `matomo-url` and `siteId` parameter.
+The createTracker function is used to instantiate a tracker object for Matomo analytics within a React Native application .It requires the parameters `matomo-url` and `siteId`, with the optional parameter `auth_token`.
+
+ <!-- If you want to create matomo auth_token refere this link https://matomo.org/faq/general/faq_114/ -->
+
 #### note 
 for matomo-url madatory to add `/matomo.php` end of url.
 
+- **Generate Auth Token**  
+  [Generate auth token guide here](https://matomo.org/faq/general/faq_114/)
+
 #### Examples
 
 ```js
@@ -68,6 +74,14 @@ for matomo-url madatory to add `/matomo.php` end of url.
 ```
 
 
+#### Examples with Auth Token
+
+```js
+
+ createTracker("https://your-matomo-url/matomo.php","siteId","auth_token")
+
+```
+
 ### startSession()
 
 The MatomoTracker starts a new session whenever the application starts. If you want to start a new session manually, you can use the startSession() function.
@@ -288,7 +302,7 @@ trackMediaEvent({siteId:"siteid",mediaId:"unique id",mediaTitle:"video media pla
 
 | Method                               | Required Parameter                                          | Android | ios | Android TV | Apple TV |
 |--------------------------------------|-----------------------------------------------------------|:-------:|:---:|:----------:|:--------:|
-| [createTracker](#createtracker)      | uri: String, siteId: Number                               |    ✅   |  ✅  |    ✅      |   ✅     |
+| [createTracker](#createtracker)      | uri: String, siteId: Number, token: String           |    ✅   |  ✅  |    ✅      |   ✅     |
 | [startSession](#startsession)        | -                                                         |    ✅   |  ✅  |    ✅      |   ✅     |
 | [trackScreen](#trackscreen)          | screenName: String, title: String                         |    ✅   |  ✅  |    ✅      |   ✅     |
 | [trackEvent](#trackevent)            | category:String, action:String, name:String, value:Number |    ✅   |  ✅  |    ✅      |   ✅     |
@@ -310,6 +324,28 @@ trackMediaEvent({siteId:"siteid",mediaId:"unique id",mediaTitle:"video media pla
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. -->
 
+## Troubleshooting
+
+<details>
+  <summary>How do I fix the tracking failure “Request was not authenticated but should have</summary>
+<br>You see a failed tracking request with this error message when you use specific tracking parameters as part of the <a href="https://developer.matomo.org/api-reference/tracking-api">HTTP tracking API</a> without authenticating the request correctly</br>
+<br>When such an error occurred, you need to make sure to set a token_auth of a user with at least write permission. If you have set a token, check the set token to make sure it is still the same and no copy/paste error has happened.</br>
+
+<br>To generate a token_auth follow these steps:</br>
+
+* Log in to Matomo 
+* Go to the Matomo Admin through the top menu
+* Click on Personal -> Security
+* At the bottom of the page click on “Create new token”
+* Confirm your account password
+* Enter the purpose for this token
+* Choose if the token should only be valid for secure requests (Matomo 5 and newer)
+
+Click on “Create new token”
+ You will now see the newly created token. Save it somewhere safe as you won’t be able to see it anymore once you leave that screen. For example, save it in a password manager. If you lose it, you will need to generate a new token.
+
+</details>
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details

android/src/main/java/com/logicwind/reactnativematomotracker/ReactNativeMatomoTrackerModule.kt

@@ -2,14 +2,17 @@ package com.logicwind.reactnativematomotracker
 
 import android.app.Application
 import android.content.ContentValues.TAG
+import android.os.Build
 import android.util.Log
+import androidx.core.content.pm.PackageInfoCompat
 import com.facebook.react.bridge.ReactApplicationContext
 import com.facebook.react.bridge.ReactContextBaseJavaModule
 import com.facebook.react.bridge.ReactMethod
+import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.OkHttpClient
 import okhttp3.Request
+import okhttp3.RequestBody.Companion.toRequestBody
 import org.matomo.sdk.Matomo
-import org.matomo.sdk.TrackMe
 import org.matomo.sdk.Tracker
 import org.matomo.sdk.TrackerBuilder
 import org.matomo.sdk.extra.TrackHelper
@@ -25,6 +28,7 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
 
   private var tracker: Tracker? = null
   private val client = OkHttpClient()
+  private var authToken: String? = null
 
   override fun getName(): String {
     return NAME
@@ -37,8 +41,11 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
 
         tracker = TrackerBuilder.createDefault(uri, siteId)
           .build(mMatomoTracker)
+
         Log.e(TAG, "initialized successfully! ${tracker}")
 
+
+
       } catch (e: Exception) {
         Log.e(TAG, "An error occurred: ${e.message}")
       }
@@ -52,7 +59,8 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
   }
 
   @ReactMethod
-  fun createTracker(uri:String,siteId:Int) {
+  fun createTracker(uri:String,siteId:Int,token:String) {
+    authToken = token;
     setTracker(uri,siteId)
   }
 
@@ -175,6 +183,7 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
     }
   }
 
+
   @ReactMethod
   fun trackMedia(
     siteId: String,
@@ -244,8 +253,17 @@ class ReactNativeMatomoTrackerModule(reactContext: ReactApplicationContext) :
     }
     try {
       val urlString = "$baseUrl?$query"
+      val jsonBody = """
+        {
+            "auth_token": "$authToken",
+        }
+      """.trimIndent()
+
+      val requestBody = jsonBody.toRequestBody("application/json; charset=utf-8".toMediaType())
+
       val request = Request.Builder()
         .url(urlString)
+        .post(requestBody)
         .build()
 
       client.newCall(request).execute().use { response ->

example/ios/Podfile.lock

@@ -7,7 +7,7 @@ PODS:
   - hermes-engine (0.74.1):
     - hermes-engine/Pre-built (= 0.74.1)
   - hermes-engine/Pre-built (0.74.1)
-  - logicwind-react-native-matomo-tracker (0.3.0):
+  - logicwind-react-native-matomo-tracker (0.3.2):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -1376,7 +1376,7 @@ SPEC CHECKSUMS:
   fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120
   glog: c5d68082e772fa1c511173d6b30a9de2c05a69a2
   hermes-engine: 16b8530de1b383cdada1476cf52d1b52f0692cbc
-  logicwind-react-native-matomo-tracker: a370c4497348c4d31730b3d09d474be3d813ef81
+  logicwind-react-native-matomo-tracker: 3875a57609e26fb4af6b2998adc3db7421d5acf6
   MatomoTracker: 1f3772a41c27393067d0126071afe6ae1c7f739e
   RCT-Folly: 02617c592a293bd6d418e0a88ff4ee1f88329b47
   RCTDeprecation: efb313d8126259e9294dc4ee0002f44a6f676aba

example/src/App.tsx

@@ -35,7 +35,6 @@ export default function App() {
 
   React.useEffect(() => {
     createTracker("https://your-matomo-url/matomo.php", 1) //Replace 1 with your matomo site id
-
   }, []);
 
   return (

ios/ReactNativeMatomoTracker.mm

@@ -3,7 +3,7 @@
 @interface RCT_EXTERN_MODULE(ReactNativeMatomoTracker, NSObject)
 
 
-RCT_EXTERN_METHOD(createTracker:(NSString *)uri withSiteId:(NSString *)siteId)
+RCT_EXTERN_METHOD(createTracker:(NSString *)uri withSiteId:(NSString *)siteId withToken:(NSString *)token)
 
 RCT_EXTERN_METHOD(trackScreen:(NSString *)screenName withTitle:(NSString *)title)
 

ios/ReactNativeMatomoTracker.swift

@@ -6,6 +6,7 @@ class ReactNativeMatomoTracker: NSObject {
 
     var matomoTracker: MatomoTracker?
     var baseURL = "";
+    var authToken = "";
     var _id = "";
     override init() {
             super.init()
@@ -16,8 +17,9 @@ class ReactNativeMatomoTracker: NSObject {
 
     }
 
-    @objc(createTracker:withSiteId:)
-    func createTracker(uri:String,siteId:String) {
+    @objc(createTracker:withSiteId:withToken:)
+    func createTracker(uri:String,siteId:String,token:String) {
+        authToken = token
         let queue = UserDefaultsQueue(UserDefaults.standard, autoSave: true)
          baseURL =  uri
 
@@ -200,7 +202,14 @@ class ReactNativeMatomoTracker: NSObject {
         let urlString = "\(baseUrl)?\(query)"
 
         if let url = URL(string: urlString) {
-            let task = URLSession.shared.dataTask(with: url) { data, response, error in
+                var request = URLRequest(url: url)
+               let device = Device.makeCurrentDevice();
+               let application = Application.makeCurrentApplication()
+               let userAgent = "Darwin/\(device.darwinVersion ?? "Unknown-Version") (\(device.platform); \(device.operatingSystem) \(device.osVersion)), MatomoTrackerSDK/\(MatomoTracker.sdkVersion)\(application.bundleName ?? "Unknown-App")/\(application.bundleShortVersion ?? "Unknown-Version")";
+                request.httpMethod = "POST"
+                request.setValue(userAgent, forHTTPHeaderField: "User-Agent")
+                request.setValue("\(authToken)", forHTTPHeaderField: "token_auth")
+                let task = URLSession.shared.dataTask(with:  request) { data, response, error in
                 if let httpResponse = response as? HTTPURLResponse {
                     let statusCode = httpResponse.statusCode
                 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logicwind/react-native-matomo-tracker",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "React-native plugin for matomo analytics",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

src/index.tsx

@@ -17,8 +17,8 @@ const ReactNativeMatomoTracker = NativeModules.ReactNativeMatomoTracker
       }
     );
 
-export function createTracker(uri: String, siteId: Number): Promise<number> {
-    return ReactNativeMatomoTracker.createTracker(uri, Platform.OS=="ios"?siteId.toString() :siteId);
+export function createTracker(uri: String, siteId: Number,token:String=""): Promise<number> {
+    return ReactNativeMatomoTracker.createTracker(uri, Platform.OS=="ios"?siteId.toString() :siteId,token);
 }
 
 export function trackScreen(screenName: String, title: String): Promise<number> {