Initial commit

Author: alan-null

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [alan-null]
+custom: ['https://www.paypal.com/paypalme/plocieniak']

.gitignore

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

Fake-UserAgent/Fake-UserAgent.psd1

@@ -0,0 +1,19 @@
+
+@{
+    RootModule        = 'Fake-UserAgent.psm1'
+    ModuleVersion     = '0.1.0'
+    GUID              = 'ef6d1c27-66ac-4f6c-8cc6-2bbae0f24543'
+    Author            = 'Alan Plocieniak'
+    CompanyName       = 'Alan Plocieniak'
+    Copyright         = '(c) 2025 Alan Plocieniak. All rights reserved.'
+    Description       = 'PowerShell module for generating random User Agents.'
+    PowerShellVersion = '5.0'
+    FunctionsToExport = '*'
+    PrivateData       = @{
+        PSData = @{
+            Tags       = @('powershell', 'fake', 'ps', 'power-shell', 'fake-useragent', 'useragent', 'user', 'agent' )
+            LicenseUri = 'https://github.com/PowerShellLibrary/Fake-UserAgent/blob/master/LICENSE.md'
+            ProjectUri = 'https://github.com/PowerShellLibrary/Fake-UserAgent'
+        }
+    }
+}

Fake-UserAgent/Fake-UserAgent.psm1

@@ -0,0 +1,12 @@
+$Public = @( Get-ChildItem -Path $PSScriptRoot\Public -Recurse -Filter *.ps1 -ErrorAction SilentlyContinue )
+$Private = @( Get-ChildItem -Path $PSScriptRoot\Private -Recurse -Filter *.ps1 -ErrorAction SilentlyContinue )
+
+Foreach ($import in @($Public + $Private)) {
+    try {
+        . $import.fullname
+    }
+    catch {
+        Write-Error -Message "Failed to import function $($import.fullname): $_"
+    }
+}
+Export-ModuleMember -Function $Public.Basename

Fake-UserAgent/Private/ConvertFrom-Gzip.ps1

@@ -0,0 +1,33 @@
+function ConvertFrom-Gzip {
+    Param (
+        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
+        [ValidateScript( { (Get-Item $_).Name.EndsWith(".gz") })]
+        [System.IO.FileInfo]
+        $InputObject,
+
+        [Parameter(Mandatory = $false)]
+        [switch]
+        $RemoveInputFile
+    )
+    Process {
+        # Create a new file and open a filestream for it
+        $NewFilename = $InputObject.FullName.Remove($InputObject.FullName.Length - $InputObject.Extension.Length)
+        $DecompressedFileStream = [System.IO.File]::Create($NewFilename)
+
+        # Open the compressed file and copy the file to the decompressed stream
+        $CompressedFileStream = $InputObject.OpenRead()
+        $GZipStream = [System.IO.Compression.GZipStream]::new($CompressedFileStream, [System.IO.Compression.CompressionMode]::Decompress)
+        $GZipStream.CopyTo($DecompressedFileStream)
+
+        # Cleanup
+        $DecompressedFileStream.Dispose()
+        $GZipStream.Dispose()
+        $CompressedFileStream.Dispose()
+        $DecompressedFileStream, $GZipStream, $CompressedFileStream = $null
+
+        # Remove the initial file if requested.
+        if ($PSBoundParameters.ContainsKey('RemoveInputFile')) {
+            $InputObject.Delete()
+        }
+    }
+}

Fake-UserAgent/Private/Get-UserAgentData.ps1

@@ -0,0 +1,11 @@
+function Get-UserAgentData {
+    [CmdletBinding()]
+
+    $datPath = Join-Path -Path $PSScriptRoot -ChildPath "..\data\user-agents.dat"
+
+    if (-Not(Test-Path $datPath)) {
+        Initialize-Dataset
+    }
+
+    Import-Clixml -Path $datPath
+}

Fake-UserAgent/Private/Initialize-Dataset.ps1

@@ -0,0 +1,39 @@
+function Initialize-Dataset {
+    Process {
+
+        $gzPath = Join-Path -Path $PSScriptRoot -ChildPath "..\data\user-agents.json.gz"
+        $jsonPath = Join-Path -Path $PSScriptRoot -ChildPath "..\data\user-agents.json"
+        $dll = Join-Path -Path $PSScriptRoot -ChildPath "..\tools\UAParser.dll"
+
+        if (-Not(Test-Path $jsonPath)) {
+            ConvertFrom-Gzip -InputObject (Get-Item -Path $gzPath)
+        }
+
+        if (-Not(Test-Path $datPath)) {
+            Add-Type -Path $dll
+            $uaParser = [UAParser.Parser]::GetDefault()
+
+
+            $jsonFile = (Get-Item -Path $jsonPath)
+            $processed = $jsonFile | Get-Content -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
+                }
+            }
+
+            $jsonFile | Remove-Item
+            $processed | Export-Clixml -Path $datPath
+        }
+    }
+}

Fake-UserAgent/Public/Get-UserAgent.ps1

@@ -0,0 +1,10 @@
+function Get-UserAgent {
+    [CmdletBinding()]
+    param ()
+
+    $data = Get-UserAgentData
+    return $data
+
+}
+
+Export-ModuleMember -Function Get-UserAgent

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

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Alan Płócieniak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Fake-UserAgent/tools/UAParser.dll

@@ -0,0 +1,43 @@
+# Fake-UserAgent
+
+PowerShell module for generating random **User Agents**.
+
+
+## How to use
+
+```powershell
+$agents = Get-UserAgent
+```
+
+Output
+
+```text
+ua                          : Mozilla/5.0 (iPhone; CPU iPhone OS 18_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.1.1 Mobile/15E148 Safari/604.1
+percent                     : 0.0969801619581542
+type                        : mobile
+device_brand                : Apple
+browser                     : Mobile Safari
+browser_version             : 18.1.1.0
+browser_version_major_minor : 18.1
+os                          : iOS
+os_version                  : 18.1.1.0
+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/)
+
+## Acknowledgements
+This project makes use of the following project
+- [**user-agents**](https://github.com/intoli/user-agents/) by [**intoli**](https://github.com/intoli)
+  *A JavaScript library for generating random user agents with data that's updated daily.*
+- [**uap-csharp**](https://github.com/ua-parser/uap-csharp/) by [**ua-parser**](https://github.com/ua-parser)
+  *C# implementation of ua-parser*
+
+## License
+[MIT License](LICENSE.md) © Alan Płócieniak
+
+
+

LICENSE.md

@@ -0,0 +1,52 @@
+Import-Module -Name Pester -Force
+Import-Module .\Fake-UserAgent\Fake-UserAgent.psm1 -Force
+
+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
+        }
+
+        It "should have user agents" {
+            $agents = Get-UserAgent
+            $agents | Should -Not -BeNullOrEmpty
+            $agents.Count | Should -BeGreaterThan 0
+        }
+
+        It "should have correct structure" {
+            $agent = Get-UserAgent | Select-Object -Skip 2 -First 1
+            $agent.ua                           | Should -Be "Mozilla/5.0 (iPhone; CPU iPhone OS 18_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.1.1 Mobile/15E148 Safari/604.1"
+            $agent.percent                      | Should -Be ([decimal]0.0969801619581542)
+            $agent.type                         | Should -Be "mobile"
+            $agent.device_brand                 | Should -Be "Apple"
+            $agent.browser                      | Should -Be "Mobile Safari"
+            $agent.browser_version              | Should -Be ([version]::new(18, 1, 1, 0))
+            $agent.browser_version_major_minor  | Should -Be ([version]::new(18, 1))
+            $agent.os                           | Should -Be "iOS"
+            $agent.os_version                   | Should -Be ([version]::new(18, 1, 1, 0))
+            $agent.platform                     | Should -Be "iPhone"
+        }
+    }
+}