Store user-agents.json.gz data as Clixml file

- removed lazy loading

Author: alan-null

.gitignore

@@ -1,2 +1,2 @@
-Fake-UserAgent/data/user-agents.json
 Fake-UserAgent/data/user-agents.dat
+temp/

Fake-UserAgent/Fake-UserAgent.psd1

@@ -1,11 +1,11 @@
 
 @{
     RootModule        = 'Fake-UserAgent.psm1'
-    ModuleVersion     = '0.1.0'
+    ModuleVersion     = '0.2.0'
     GUID              = 'ef6d1c27-66ac-4f6c-8cc6-2bbae0f24543'
     Author            = 'Alan Plocieniak'
     CompanyName       = 'Alan Plocieniak'
-    Copyright         = '(c) 2025 Alan Plocieniak. All rights reserved.'
+    Copyright         = '(c) Alan Plocieniak. All rights reserved.'
     Description       = 'PowerShell module for generating random User Agents.'
     PowerShellVersion = '5.0'
     FunctionsToExport = '*'

Fake-UserAgent/Private/Initialize-Dataset.ps1

@@ -1,4 +1,5 @@
 # Fake-UserAgent
+[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/Fake-UserAgent?label=Fake-UserAgent&color=blue&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciICB2aWV3Qm94PSIwIDAgNDggNDgiIHdpZHRoPSI0OHB4IiBoZWlnaHQ9IjQ4cHgiPjxwYXRoIGZpbGw9IiMwMjc3YmQiIGQ9Ik0xOS44NDcsNDEuOTU2Yy01LjYyOS0wLjAwMi0xMS4yNTksMC4wMjQtMTYuODg4LTAuMDEzYy0yLjg1NS0wLjAxOS0zLjM3NC0wLjctMi43MzEtMy41MjUgYzIuMTc4LTkuNTgsNC40MjctMTkuMTQzLDYuNTU3LTI4LjczNEM3LjM1Niw3LjExMiw4LjU4OCw1Ljk3NSwxMS4zMTIsNkMyMi41Nyw2LjEwNiwzMy44MjksNi4wMzQsNDUuMDg4LDYuMDQ2IGMyLjgyNCwwLjAwMywzLjI5OCwwLjYxNCwyLjY2NCwzLjUxMWMtMi4wNTgsOS40MDYtNC4xMjksMTguODA5LTYuMjM2LDI4LjIwM2MtMC43ODksMy41MTYtMS42OTcsNC4xODctNS4zNTMsNC4xOTUgQzMwLjcyNCw0MS45NjYsMjUuMjg1LDQxLjk1OCwxOS44NDcsNDEuOTU2eiIvPjxwYXRoIGZpbGw9IiNmYWZhZmEiIGQ9Ik0yNS4wNTcgMjMuOTIyYy0uNjA4LS42ODctMS4xMTQtMS4yNjctMS41MzEtMS43MzItMi40My0yLjcyOC00LjY1Ni01LjI3LTcuMDYzLTcuODY5LTEuMTAyLTEuMTg5LTEuNDUzLTIuMzQ0LS4xMy0zLjUxOCAxLjMwNy0xLjE2IDIuNTkyLTEuMDU4IDMuNzkxLjI3NyAzLjM0IDMuNzE3IDYuNjc2IDcuNDM4IDEwLjA3MSAxMS4xMDQgMS4yNjggMS4zNjkuOTcyIDIuMy0uNDI0IDMuMzE1LTUuMzU5IDMuODk1LTEwLjY4NyA3LjgzMy0xNi4wMSAxMS43NzgtMS4xOTYuODg3LTIuMzM3IDEuMTA5LTMuMzA0LS4yMDEtMS4wNjYtMS40NDUtLjA4LTIuMzA1IDEuMDI2LTMuMTE0IDMuOTU1LTIuODkzIDcuOTAzLTUuNzk4IDExLjgzNC04LjcyNUMyMy44NjUgMjQuODMgMjQuNTk1IDI0LjI2NyAyNS4wNTcgMjMuOTIyek0yMS43NSAzN0MyMC42MjUgMzcgMjAgMzYgMjAgMzVzLjYyNS0yIDEuNzUtMmM0LjIyNCAwIDYuMTEyIDAgOS41IDAgMS4xMjUgMCAxLjc1IDEgMS43NSAycy0uNjI1IDItMS43NSAyQzI5LjEyNSAzNyAyNSAzNyAyMS43NSAzN3oiLz48L3N2Zz4=)](https://www.powershellgallery.com/packages/Fake-UserAgent)
 
 PowerShell module for generating random **User Agents**.
 
@@ -26,8 +27,14 @@ platform                    : iPhone
 
 ## How it works
 
-- module comes with `user-agents.json.gz` downloaded from [**user-agents**](https://github.com/intoli/user-agents/)
-- during first cmdlet call data will be unpacked and converted into **user-agents.dat** with help of [**uap-csharp**](https://github.com/ua-parser/uap-csharp/)
+Module comes with bundled `user-agents.dat` file which contains different User Agent entries.
+
+The process of creating it:
+- Download the version of **user-agents.json** from [**user-agents**](https://github.com/intoli/user-agents/)
+- Preprocess using [**uap-csharp**](https://github.com/ua-parser/uap-csharp/)
+- Serialize into an XML-based representation (Common Language Infrastructure (CLI)) of all the objects
+- Optimize for smaller size
+- Store as a file `user-agents.dat`
 
 ## Acknowledgements
 This project makes use of the following project

Fake-UserAgent/data/user-agents.json.gz

@@ -5,27 +5,10 @@ Describe 'Fake-UserAgent.Tests' {
     Context "Get-UserAgentData Tests" {
 
         BeforeAll {
-            $gzPath = '.\Fake-UserAgent\data\user-agents.json.gz'
-            $jsonPath = '.\Fake-UserAgent\data\user-agents.json'
             $datPath = '.\Fake-UserAgent\data\user-agents.dat'
-
-            Remove-Item -Path $jsonPath -ErrorAction SilentlyContinue
-            Remove-Item -Path $datPath -ErrorAction SilentlyContinue
-        }
-
-        It "should have initial state" {
-            Test-Path $gzPath | Should -Be $true
-            Test-Path $jsonPath | Should -Be $false
-            Test-Path $datPath | Should -Be $false
-        }
-
-        It "should not throw exception during initialization" {
-            { Get-UserAgent } | Should -Not -Throw
         }
 
         It "should have initialized state" {
-            Test-Path $gzPath | Should -Be $true
-            Test-Path $jsonPath | Should -Be $false
             Test-Path $datPath | Should -Be $true
         }
 
@@ -49,4 +32,24 @@ Describe 'Fake-UserAgent.Tests' {
             $agent.platform                     | Should -Be "iPhone"
         }
     }
+
+    Context "UA file update Tests" {
+
+        BeforeAll {
+            $datPath = '.\Fake-UserAgent\data\user-agents.dat'
+            Remove-Item -Path $datPath -ErrorAction SilentlyContinue
+        }
+
+        It "should have initial state" {
+            Test-Path $datPath | Should -Be $false
+        }
+
+        It "should download and update user agents" {
+            { .\update-data.ps1 } | Should -Not -Throw
+        }
+
+        It "should have initialized state" {
+            Test-Path $datPath | Should -Be $true
+        }
+    }
 }

README.md

@@ -0,0 +1,23 @@
+function Initialize-Dataset {
+    param (
+        [string]$uaJsonPath = "user-agents.json"
+    )
+    Process {
+
+        Get-Content $uaJsonPath -Raw | ConvertFrom-Json | % {
+            $ua_result = $uaParser.Parse($_.userAgent)
+            [PSCustomObject]@{
+                ua                          = $_.userAgent
+                percent                     = [decimal]($_.weight * 100)
+                type                        = $_.deviceCategory
+                device_brand                = $ua_result.Device.Brand
+                browser                     = $ua_result.UserAgent.Family
+                browser_version             = [version]::new($ua_result.UserAgent.Major, $ua_result.UserAgent.Minor, $ua_result.UserAgent.Patch, $ua_result.UserAgent.PatchMinor)
+                browser_version_major_minor = [version]::new($ua_result.UserAgent.Major, $ua_result.UserAgent.Minor)
+                os                          = $ua_result.OS.Family
+                os_version                  = [version]::new($ua_result.OS.Major, $ua_result.OS.Minor, $ua_result.OS.Patch, $ua_result.OS.PatchMinor)
+                platform                    = $_.platform
+            }
+        }
+    }
+}

Tests/Toggl.API.Tests.ps1

@@ -0,0 +1,38 @@
+Write-Host 'Updating user-agent data...'
+$uaJsonUri = "https://raw.githubusercontent.com/intoli/user-agents/main/src/user-agents.json.gz"
+
+Write-Host 'Importing required modules...'
+. .\scripts\ConvertFrom-Gzip.ps1
+. .\scripts\Initialize-Dataset.ps1
+Add-Type -Path .\tools\UAParser.dll
+
+Write-Host 'Cleaning up temp directory...'
+$temp = "temp"
+if (Test-Path $temp) {
+    Remove-Item -Path $temp -Recurse -Force
+}
+New-Item -ItemType Directory -Path $temp | Out-Null
+Push-Location -Path $temp
+
+
+Write-Host 'Downloading user-agents.json...'
+Invoke-WebRequest -Uri $uaJsonUri -OutFile "user-agents.json.gz"
+
+Write-Host 'Decompressing user-agents.json...'
+ConvertFrom-Gzip -InputObject (Get-Item "user-agents.json.gz") -RemoveInputFile
+
+Write-Host 'Processing user-agents.json...'
+$processed = Initialize-Dataset -uaJsonPath "user-agents.json"
+
+Pop-Location
+
+Write-Host 'Exporting user-agents.dat...'
+Push-Location .\Fake-UserAgent\data
+$processed | Export-Clixml -Path user-agents.clixml -NoClobber
+
+Write-Host 'Optimizing file size...'
+Get-Content .\user-agents.clixml -Raw | ForEach-Object { $_ -replace '\s+(?=<)', '' } | Set-Content .\user-agents.dat
+Remove-Item .\user-agents.clixml
+Pop-Location
+
+Write-Host 'Done!'