Revert module version to 1.5.3 in the module manifest

.gitea/workflows/Publish Module.yaml

@@ -72,7 +72,7 @@ jobs:
           Set-Location -Path ${{ github.workspace }}
           $moduleVersion = git describe --tags
           Write-Host "Module version: $moduleVersion"
-          $module = get-childItem -path . -Directory -Exclude ".*" | Select-Object -ExpandProperty Name
+          $module = get-childItem -path . -Directory -Exclude (".*", "Tests") | Select-Object -ExpandProperty Name
           Write-Host "Publishing module $module to Gitea"
           Publish-Module -Path $module -Repository 'GiteaPublic' -NuGetApiKey "${{ secrets.PACKAGES_TOKEN }}"
           Write-Host "Module $module published to Gitea"

PS-GiteaUtilities/PS-GiteaUtilities.psd1

@@ -12,7 +12,7 @@
 RootModule = 'PS-GiteaUtilities.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.3.1'
+ModuleVersion = '1.5.3'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -69,7 +69,7 @@ PowerShellVersion = '5.1'
 # NestedModules = @()
 
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = 'Set-GiteaConfiguration', 'Get-GiteaConfiguration', 'Get-GiteaFileContent', 'Invoke-GiteaFileDownload', 'Get-GiteaChildItem'
+FunctionsToExport = 'Set-GiteaConfiguration', 'Get-GiteaConfiguration', 'Get-GiteaFileContent', 'Invoke-GiteaFileDownload', 'Get-GiteaChildItem', 'Get-GiteaReleases'
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 CmdletsToExport = '*'

PS-GiteaUtilities/PS-GiteaUtilities.psm1

@@ -207,7 +207,7 @@ Function Get-GiteaFileContent {
                     Content = $content
                     Size = $fileContent.size
                     SHA = $fileContent.sha
-                    Success = $true
+                    Result = 'Success'
                     Error = $null
                 }
             }
@@ -218,7 +218,7 @@ Function Get-GiteaFileContent {
                     Content = $null
                     Size = $null
                     SHA = $null
-                    Success = $false
+                    Result = 'Failure'
                     Error = $_.Exception.Message
                 }
             }
@@ -324,27 +324,40 @@ Function Invoke-GiteaFileDownload {
     A personal access token for the Gitea server.
 
     .PARAMETER outputPath
-    The path where the downloaded file should be saved. If not specified, the file will be saved in the current directory using the filename from the URL.
+    The path where the downloaded file should be saved. If not specified, the file will be saved in the current directory with its original name from the download URL.
+    If using PreserveRelativePath, outputPath is treated as the base directory to append the relative path to.
 
-    .PARAMETER force
-    A switch parameter to force overwriting of an existing file at the output path.
+    .PARAMETER outputName
+    The name of the file to save the downloaded content as. If not specified, the file will be saved with its original name from the download URL.
+    Cannot be used with PreserveRelativePath.
     
     .PARAMETER PreserveRelativePath
     A switch parameter to preserve the relative path structure from the repository. 
     If used without specifying an outputPath, creates the directory structure in the current location.
     If used with outputPath, treats the outputPath as the base directory to append the relative path to.
+    Cannot be used with outputName.
+
+    .PARAMETER OverwriteByHash
+    A switch parameter to overwrite the file if it exists based on its hash.
     
+    .PARAMETER force
+    A switch parameter to force overwriting of an existing file at the output path.
+
     .PARAMETER type
     The type of the item to download (file, dir, lfs). This parameter is typically used with pipeline input from Get-GiteaChildItem.
     Directories will be skipped with a verbose message.
 
+    .PARAMETER sha
+    The SHA of the file to download. This parameter is typically used with pipeline input from Get-GiteaChildItem.
+    Can be combined with OverwriteByHash to overwrite an existing file if the hashes do not match.
+
     .EXAMPLE
     # Example 1: Download a file to the current directory
     Invoke-GiteaFileDownload -downloadURL "https://gitea.example.com/api/v1/repos/owner/repo/raw/path/to/file.txt" -token "your_token"
 
     .EXAMPLE
     # Example 2: Download a file to a specific location with force overwrite
-    Invoke-GiteaFileDownload -downloadURL "https://gitea.example.com/api/v1/repos/owner/repo/raw/path/to/file.txt" -token "your_token" -outputPath "C:\Downloads\file.txt" -force
+    Invoke-GiteaFileDownload -downloadURL "https://gitea.example.com/api/v1/repos/owner/repo/raw/path/to/file.txt" -token "your_token" -outputPath "C:\Downloads\" -outputName "file.txt" -force
     
     .EXAMPLE
     # Example 3: Download files in pipeline from Get-GiteaChildItem 
@@ -366,12 +379,15 @@ Function Invoke-GiteaFileDownload {
         [string]$token,
         [Parameter(ValueFromPipelineByPropertyName)]
         [string]$outputPath,
+        [Parameter(ValueFromPipelineByPropertyName)]
+        [string]$outputName,
+        [switch]$PreserveRelativePath,
+        [switch]$OverwriteByHash,
         [switch]$force,
         [Parameter(ValueFromPipelineByPropertyName)]
-        [string]$filePath,
-        [switch]$PreserveRelativePath,
+        [string]$type,
         [Parameter(ValueFromPipelineByPropertyName)]
-        [string]$type
+        [string]$sha
     )
 
     begin {
@@ -392,6 +408,11 @@ Function Invoke-GiteaFileDownload {
         Write-Verbose "Parameters:"
         Write-Debug "Token: $token (length: $(if($token){$token.Length}else{0}))"
         Write-Verbose "PreserveRelativePath: $PreserveRelativePath"
+
+        # Ensure PreserveRelativePath is not used with outputName
+        if ($PreserveRelativePath -and $PSBoundParameters.ContainsKey('outputName')) {
+            throw "The -PreserveRelativePath switch cannot be used with the -outputName parameter. Use -outputPath instead."
+        }
         
         # Create a WebClient to be reused
         $webClient = New-Object System.Net.WebClient
@@ -399,21 +420,22 @@ Function Invoke-GiteaFileDownload {
     }
 
     process {
-        # Normalize path separators for cross-platform compatibility
-        $filePath = $filePath -replace '\\', '/'
-        Write-Verbose "File path: $filePath"
+        # If type is not provided, check for any hints for cases such as LFS where a type can be inferred and special handling is needed
+        If($downloadURL -match "/api/v1/repos/[^/]+/[^/]+/media/") {
+            $type = "lfs"
+        }
+
         Write-Verbose "Type: $type"
-        
+        # Handle the type parameter
+
         # Skip directories and provide a verbose message
         if ($type -eq "dir") {
-            Write-Verbose "Skipping directory: $filePath"
+            Write-Verbose "Skipping directory"
             return [PSCustomObject]@{
-                Path = $filePath
                 SourceURL = $downloadURL
-                FilePath = $filePath
                 Type = $type
-                Success = $true
-                Error = "Skipped - item is a directory"
+                Result = 'Skipped'
+                Error = $null
                 Timestamp = Get-Date
                 FileSize = $null
             }
@@ -421,104 +443,144 @@ Function Invoke-GiteaFileDownload {
         
         # Handle invalid entry types
         if ([string]::IsNullOrEmpty($type) -and [string]::IsNullOrEmpty($downloadURL)) {
-            $errorMsg = "Invalid item type or missing download URL for path: $filePath"
+            $errorMsg = "Invalid item type or missing download URL for path"
             Write-Error $errorMsg
             return [PSCustomObject]@{
-                Path = $filePath
                 SourceURL = $downloadURL
-                FilePath = $filePath
                 Type = $type
-                Success = $false
+                Result = 'Failure'
                 Error = $errorMsg
                 Timestamp = Get-Date
                 FileSize = $null
             }
         }
         
-        Write-Verbose "Processing download URL: $downloadURL"
 
-        # Set the output path based on parameters
-        $currentOutputPath = ""
-        
-        # Get the file name from the download URL or file path
-        $outputFileName = $downloadURL.Substring($downloadURL.LastIndexOf("/") + 1)
-        # Clean the file name by removing any query string parameters and HTML encoded characters
-        $outputFileName = [System.Uri]::UnescapeDataString($outputFileName.Split("?")[0])
-        
-        if ($PreserveRelativePath -and $filePath) {
-            # If PreserveRelativePath is used, set up the directory structure
-            Write-Verbose "Preserving relative path structure for: $filePath"
-            
-            if ($outputPath) {
-                # If outputPath is specified, use it as the base directory
-                $baseDir = $outputPath
-                Write-Verbose "Using base directory: $baseDir"
-                
-                # Combine the base directory with the file path
-                $currentOutputPath = Join-Path -Path $baseDir -ChildPath $filePath
-            } else {
-                # If no outputPath is specified, use the current directory as base
-                $currentOutputPath = Join-Path -Path (Get-Location) -ChildPath $filePath
-            }
-            
-            # Normalize path separators
-            $currentOutputPath = $currentOutputPath.Replace("/", [System.IO.Path]::DirectorySeparatorChar)
-            Write-Verbose "Output path with preserved structure: $currentOutputPath"
-        } else {
-            # Standard path handling (unchanged from original)
-            if ($outputPath) {
-                $currentOutputPath = $outputPath
-            } else {
-                # Append the outputFileName to the current location
-                $currentOutputPath = Join-Path -Path (Get-Location) -ChildPath $outputFileName
-            }
-            Write-Verbose "Output path: $currentOutputPath"
+        # Parse the download URL to extract the file path and file name
+
+        # Separate the URL into its components: Gitea URL, Repo Owner, Repo Name, branch, file path, and file name
+        $uri = New-Object System.Uri($downloadURL)
+        $pathSegments = $uri.AbsolutePath.Trim('/').Split('/')
+        If($type -eq "lfs") {
+            # Everything after the media segment is considered the file path with the last segment being the file name
+            $branchIndex = [Array]::IndexOf($pathSegments, "media") + 1
+            $DownloadFilePath = $pathSegments[$branchIndex..($pathSegments.Length - 2)] -join '/'
+            $DownloadFileName = $pathSegments[-1]
+        }
+        Else {
+            # Everything after the branch + 1 segment is considered the file path with the last segment being the file name
+            $branchIndex = [Array]::IndexOf($pathSegments, "branch") + 2
+            $DownloadFilePath = $pathSegments[$branchIndex..($pathSegments.Length - 2)] -join '/'
+            # Replace any URL encoded characters in the file name
+            $DownloadFileName = $pathSegments[-1]
         }
 
+        $DownloadFilePath = [System.Uri]::UnescapeDataString($DownloadFilePath)
+                
+        if ($PreserveRelativePath -and $outputPath) {
+            # If PreserveRelativePath is used, set up the directory structure
+            Write-Verbose "Preserving relative path structure for: $DownloadFileName"
+
+            $baseDir = $outputPath
+            Write-Verbose "Using base directory: $baseDir"
+            
+            # Combine the base directory with the file path
+            $fileOutputPath = Join-Path -Path $baseDir -ChildPath $DownloadFilePath
+            # Combine with the file name
+            $fileOutputPath = Join-Path -Path $fileOutputPath -ChildPath $DownloadFileName
+            } 
+        elseif($PreserveRelativePath) {
+            # If no outputPath is specified, use the current directory as base and the file name from the download URL
+            $fileOutputPath = Join-Path -Path (Get-Location) -ChildPath $DownloadFilePath
+            # Combine with the file name
+            $fileOutputPath = Join-Path -Path $fileOutputPath -ChildPath $DownloadFileName
+        }
+        elseif ($outputPath -and $outputName) {
+            # If both outputPath and outputName are specified, use outputPath as the base directory with the file name specified by outputName
+            $fileOutputPath = Join-Path -Path $outputPath -ChildPath $outputName
+        }
+        elseif ($outputPath) {
+            # If outputPath is specified, use it as the base directory with the file name from the download URL
+            $fileOutputPath = Join-Path -Path $outputPath -ChildPath $DownloadFileName
+        }
+        elseif($outputName) {
+            # If only outputName is specified, use the current directory with the specified outputName
+            $fileOutputPath = Join-Path -Path (Get-Location) -ChildPath $outputName
+        }
+        else {
+            # Fallback to current directory with the file name from the download URL
+            $fileOutputPath = Join-Path -Path (Get-Location) -ChildPath $DownloadFileName
+        }
+
+        # Normalize path separators
+        $fileOutputPath = $fileOutputPath.Replace("/", [System.IO.Path]::DirectorySeparatorChar)
+
+        
+        Write-Verbose "Output path: $fileOutputPath"
+
         $result = [PSCustomObject]@{
-            Path = $currentOutputPath
+            Path = $fileOutputPath
             SourceURL = $downloadURL
-            FilePath = $filePath
-            Type = $type
-            Success = $false
+            Type = "file"
+            Result = $null
             Error = $null
             Timestamp = Get-Date
             FileSize = $null
         }
 
-        if((Test-Path -Path $currentOutputPath -PathType Leaf) -and (-not $force)) {
-            $errorMsg = "The file '$currentOutputPath' already exists. Use the -Force switch to overwrite the file."
-            Write-Error $errorMsg
-            $result.Error = $errorMsg
-            return $result
+        if((Test-Path -Path $fileOutputPath -PathType Leaf) -and (-not $force)) {
+            # Check if OverwriteByHash is set
+            if ($OverwriteByHash) {
+                Write-Verbose "OverwriteByHash is set; checking file hash for existing file: $fileOutputPath"
+                $existingFileHash = (Get-FileHash -Path $fileOutputPath -Algorithm SHA256).Hash
+                $downloadFileHash = $sha
+                
+                if ($existingFileHash -eq $downloadFileHash) {
+                    Write-Host "The file '$fileOutputPath' already exists and hashes match. Skipping download."
+                    $result.Result = 'Skipped'
+                    return $result
+                }
+                else {
+                    Write-Host "The file '$fileOutputPath' already exists but hashes do not match and OverwriteByHash is set; overwriting file."
+
+                }
+            }
+            else {
+                $result.Result = 'Skipped'
+                $errorMsg = "The file '$fileOutputPath' already exists. Use the -Force switch to overwrite the file."
+                Write-Error $errorMsg
+                $result.Error = $errorMsg
+                return $result
+            }
         }
 
         try {
             # Create the directory structure if it doesn't exist
-            $directory = Split-Path -Path $currentOutputPath -Parent
+            $directory = Split-Path -Path $fileOutputPath -Parent
             if (-not (Test-Path -Path $directory -PathType Container) -and $directory) {
                 Write-Verbose "Creating directory structure: $directory"
                 New-Item -Path $directory -ItemType Directory -Force | Out-Null
             }
 
             # Download the file
-            Write-Verbose "Downloading from $downloadURL to $currentOutputPath"
+            Write-Verbose "Downloading from $downloadURL to $fileOutputPath"
             
             # Use synchronous download
-            $webClient.DownloadFile($downloadURL, $currentOutputPath)
+            $webClient.DownloadFile($downloadURL, $fileOutputPath)
             
-            Write-Verbose "File downloaded successfully to $currentOutputPath"
+            Write-Verbose "File downloaded successfully to $fileOutputPath"
             
             # Get file info for the result object
-            if (Test-Path -Path $currentOutputPath -PathType Leaf) {
-                $fileInfo = Get-Item -Path $currentOutputPath
+            if (Test-Path -Path $fileOutputPath -PathType Leaf) {
+                $fileInfo = Get-Item -Path $fileOutputPath
                 $result.FileSize = $fileInfo.Length
             }
             
-            $result.Success = $true
+            $result.Result = 'Success'
             return $result
         }
         catch {
+            $result.Result = 'Failure'
             $errorMsg = "Failed to download file from Gitea: $_"
             Write-Error $errorMsg
             $result.Error = $errorMsg
@@ -715,7 +777,7 @@ Function Get-GiteaChildItem {
                             $item.size = [long]$matches[1]
                         }
                         # Set the download URL to the media endpoint for LFS files to download the actual file
-                        $item.download_url = "$giteaURL/api/v1/repos/$repoOwner/$repoName/media/$($item.path)"
+                        $item.download_url = "$giteaURL/api/v1/repos/$repoOwner/$repoName/media/$($item.path)?ref=$branch"
                     }
 
                     $itemObj = [PSCustomObject]@{
@@ -725,7 +787,7 @@ Function Get-GiteaChildItem {
                         size = $item.size
                         sha = $item.sha
                         downloadURL = $item.download_url
-                        Success = $true
+                        Result = 'Success'
                         Error = $null
                         Level = 0
                     }
@@ -808,7 +870,7 @@ Function Get-GiteaChildItem {
                                     size = $subItem.size
                                     sha = $subItem.sha
                                     downloadURL = $subItem.download_url
-                                    Success = $true
+                                    Result = 'Success'
                                     Error = $null
                                     Level = $currentLevel
                                 }
@@ -855,7 +917,7 @@ Function Get-GiteaChildItem {
                     size = $null
                     sha = $null
                     downloadURL = $null
-                    Success = $false
+                    Result = 'Failure'
                     Error = $_.Exception.Message
                     Level = 0
                 }
@@ -1012,4 +1074,4 @@ function Get-GiteaReleases {
     }
 }
 
-Export-ModuleMember -Function Set-GiteaConfiguration, Get-GiteaConfiguration, Get-GiteaFileContent, Invoke-GiteaFileDownload, Get-GiteaChildItem, Get-GiteaLFSFile, Get-GiteaReleases
+# Export-ModuleMember -Function Set-GiteaConfiguration, Get-GiteaConfiguration, Get-GiteaFileContent, Invoke-GiteaFileDownload, Get-GiteaChildItem, Get-GiteaReleases

Tests/Get-GiteaChildItem.Tests.ps1

@@ -1,7 +1,7 @@
 # Get-GiteaChildItem.Tests.ps1
 
 # Import the module under test
-$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
+$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities\PS-GiteaUtilities.psm1'
 Import-Module -Name $modulePath -Force
 
 Describe 'Get-GiteaChildItem' {

Tests/Get-GiteaConfiguration.tests.ps1

@@ -1,7 +1,7 @@
 # Get-GiteaConfiguration.Tests.ps1
 
 # Import the module under test
-$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
+$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities\PS-GiteaUtilities.psm1'
 Import-Module -Name $modulePath -Force
 
 Describe 'Get-GiteaConfiguration' {

Tests/Get-GiteaFileContent.Tests.ps1

@@ -1,7 +1,7 @@
 # Get-GiteaFileContent.Tests.ps1
 
 # Import the module under test
-$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
+$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities\PS-GiteaUtilities.psm1'
 Import-Module -Name $modulePath -Force
 
 Describe 'Get-GiteaFileContent' {
@@ -21,7 +21,7 @@ Describe 'Get-GiteaFileContent' {
             $result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'README.md' -token 'abc123'
 
             $result | Should -Not -BeNullOrEmpty
-            $result.Success | Should -Be $true
+            $result.Result | Should -Be 'Success'
             $result.Content | Should -Be ([System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Hello World')))
         }
 
@@ -29,7 +29,7 @@ Describe 'Get-GiteaFileContent' {
             $result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'README.md' -token 'abc123' -decode
 
             $result | Should -Not -BeNullOrEmpty
-            $result.Success | Should -Be $true
+            $result.Result | Should -Be 'Success'
             $result.Content | Should -Be 'Hello World'
         }
     }
@@ -73,7 +73,7 @@ Describe 'Get-GiteaFileContent' {
         It 'Should capture error and mark result as unsuccessful' {
             $result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'badfile.ps1' -token 'abc123'
     
-            $result.Success | Should -Be $false
+            $result.Result | Should -Be 'Failure'
             $result.Error | Should -Match 'API call failed'
         }
     }
@@ -103,7 +103,7 @@ Describe 'Get-GiteaFileContent' {
             $result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'testfile.txt' -token 'abc123'
     
             $result | Should -Not -BeNullOrEmpty
-            $result.Success | Should -Be $true
+            $result.Result | Should -Be 'Success'
             $result.Content | Should -Be ([System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes('Hello from API!')))
         }
     
@@ -111,7 +111,7 @@ Describe 'Get-GiteaFileContent' {
             $result = Get-GiteaFileContent -repoOwner 'user' -repoName 'repo' -filePath 'testfile.txt' -token 'abc123' -decode
     
             $result | Should -Not -BeNullOrEmpty
-            $result.Success | Should -Be $true
+            $result.Result | Should -Be 'Success'
             $result.Content | Should -Be 'Hello from API!'
         }
     }

Tests/Get-GiteaReleases.Tests.ps1

@@ -1,7 +1,7 @@
 # Get-GiteaReleases.Tests.ps1
 
 # Import the module
-$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
+$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities\PS-GiteaUtilities.psm1'
 Import-Module -Name $modulePath -Force
 
 Describe 'Get-GiteaReleases' {

Tests/Invoke-GiteaFileDownload.Tests.ps1

@@ -1,7 +1,7 @@
 # Invoke-GiteaFileDownload.Tests.ps1
 
 # Import the module under test
-$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
+$modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities\PS-GiteaUtilities.psm1'
 Import-Module -Name $modulePath -Force
 
 Describe 'Invoke-GiteaFileDownload' {
@@ -13,7 +13,7 @@ Describe 'Invoke-GiteaFileDownload' {
         }
 
         # Correct webClient Mock: headers, download, dispose
-        Mock -CommandName New-Object -ModuleName PS-GiteaUtilities -MockWith {
+        Mock -CommandName New-Object -ModuleName PS-GiteaUtilities -ParameterFilter { $TypeName -eq 'System.Net.WebClient' } -MockWith {
             $headers = New-Object System.Net.WebHeaderCollection
         
             # Create a real object
@@ -49,27 +49,56 @@ Describe 'Invoke-GiteaFileDownload' {
             $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' -token 'abc123'
 
             $result | Should -Not -BeNullOrEmpty
-            $result.Success | Should -Be $true
+            $result.Result | Should -Be 'Success'
             $result.Path | Should -Match 'file\.txt$'
         }
     }
 
-    Context 'When preserving relative paths' {
-        It 'Should create a path based on filePath with PreserveRelativePath' {
+    Context 'When specifying an outputPath' {
+        It 'Should create a path based on outputPath' {
             $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' `
-                -filePath 'docs/manual/file.txt' -PreserveRelativePath -token 'abc123'
+            -outputPath 'docs/manual/' -token 'abc123'
 
             $result.Path | Should -Match 'docs[\\/]+manual[\\/]+file\.txt$'
-            $result.Success | Should -Be $true
+            $result.Result | Should -Be 'Success'
+        }
+    }
+
+    Context 'When specifying an outputName' {
+        It 'Should download file and name it based on outputName' {
+            $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' `
+            -outputName 'newfile.txt' -token 'abc123'
+
+            $result.Path | Should -Match 'newfile\.txt$'
+            $result.Result | Should -Be 'Success'
+        }
+    }
+
+    Context 'When specifying an outputName and outputPath' {
+        It 'Should download file and name it based on outputName' {
+            $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' `
+            -outputPath 'docs/manual/' -outputName 'newfile.txt' -token 'abc123'
+
+            $result.Path | Should -Match 'docs[\\/]+manual[\\/]+newfile\.txt$'
+            $result.Result | Should -Be 'Success'
+        }
+    }
+
+    Context 'When using -PreserveRelativePath' {
+        It 'Should preserve the relative path structure' {
+            $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/file.txt' `
+            -PreserveRelativePath -token 'abc123'
+
+            $result.Path | Should -Match 'path[\\/]+to[\\/]+file\.txt$'
+            $result.Result | Should -Be 'Success'
         }
     }
 
     Context 'When skipping directories' {
         It 'Should skip items with type = dir' {
-            $result = Invoke-GiteaFileDownload -filePath 'docs/' -type 'dir' -token 'abc123'
+            $result = Invoke-GiteaFileDownload -outputPath 'docs/' -type 'dir' -token 'abc123'
 
-            $result.Success | Should -Be $true
-            $result.Error | Should -Match 'Skipped'
+            $result.Result | Should -Be 'Skipped'
         }
     }
 
@@ -86,14 +115,13 @@ Describe 'Invoke-GiteaFileDownload' {
         It 'Should not overwrite existing file without Force' {
             $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/existingfile.txt' -token 'abc123'
 
-            $result.Success | Should -Be $false
-            $result.Error | Should -Match 'already exists'
+            $result.Result | Should -Be 'Skipped'
         }
     }
 
     Context 'When download fails' {
         BeforeEach {
-            Mock -CommandName New-Object -ModuleName PS-GiteaUtilities -MockWith {
+            Mock -CommandName New-Object -ModuleName PS-GiteaUtilities -ParameterFilter { $TypeName -eq 'System.Net.WebClient' } -MockWith {
                 $headers = New-Object System.Net.WebHeaderCollection
     
                 $webClient = New-Object PSObject
@@ -115,7 +143,7 @@ Describe 'Invoke-GiteaFileDownload' {
         It 'Should capture error and mark download as failed' {
             $result = Invoke-GiteaFileDownload -downloadURL 'https://gitea.example.com/raw/path/to/badfile.txt' -token 'abc123'
     
-            $result.Success | Should -Be $false
+            $result.Result | Should -Be 'Failure'
             $result.Error | Should -Match 'Failed to download'
         }
     }

Tests/Set-GiteaConfiguration.Tests.ps1

@@ -4,7 +4,7 @@ Describe 'Set-GiteaConfiguration' {
 
     BeforeAll {
     # Import the module dynamically
-    $modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities.psm1'
+    $modulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\PS-GiteaUtilities\PS-GiteaUtilities.psm1'
     Import-Module -Name $modulePath -Force
 
     }