[Feature] Meta - Add the Meta functions (#22)

- Fix Authentication issues with DeviceFlow
  - Fixes #20 
  - Fixes #19
- The Auth module now supports Device Flow for both GitHubApp, OAuthApp,
PAT and System PAT.
    - If running Connect-GitHubAccount the flow will do the following:
      - If system tokens are available, use those to log in.
- Else trigger device flow. Check if access token is valid. if token is
valid for less than 4 hours, refresh the token using the device flow
refresh token process. Same if access token is expired.
- If refresh token is expired, trigger new device flow auth process.
- If type of auth changes due to switchs, trigger new device flow auth
process.
- If running Connect-GitHubAccount -AccessToken is run, an interactive
process is assumed. A prompt will ask the user to provide a PAT token,
which can be both Fine grained or classic.
- Changed so tokens are treated as SecureStrings from its stored until
its put in the function/command that uses it, and converts it there.

- Fixes #23 
- Configuration is now stored with a prefix that is configured in the
SecretVault.psd1 file in the data folder. Default this is "GHPS_". All
settings written to the secret store uses this.

- Adds an API call method `Invoke-GitHubAPI` to manage all the calls to
the GitHub API
- Includes default usage of settings, like ApiBaseUri, AccessToken (now
as a SecureString) and Version for the api version.
- Supports pagination, in line with [Using pagination in the REST
API](https://docs.github.com/en/rest/guides/using-pagination-in-the-rest-api?apiVersion=2022-11-28)
- Fixes #12 
  - Adds functions under the Meta namespace.

Author: MariusStorhaug

src/GitHub/GitHub.ps1

@@ -1,14 +1,12 @@
-Write-Verbose "Initializing GitHub module..." -Verbose
+$scriptFilePath = $MyInvocation.MyCommand.Path
+
+Write-Verbose "[$scriptFilePath] - Initializing GitHub module..." -Verbose
 
-$script:Config = $script:ConfigTemplate | ConvertTo-Json -Depth 100 | ConvertFrom-Json
 Initialize-SecretVault -Name $script:SecretVault.Name -Type $script:SecretVault.Type
-Restore-GitHubConfig
 
-if (-not [string]::IsNullOrEmpty($env:GH_TOKEN)) {
-    Write-Verbose 'Logging on using GH_TOKEN'
-    Connect-GitHubAccount -AccessToken $env:GH_TOKEN
-}
-if (-not [string]::IsNullOrEmpty($env:GITHUB_TOKEN)) {
-    Write-Verbose 'Logging on using GITHUB_TOKEN'
-    Connect-GitHubAccount -AccessToken $env:GITHUB_TOKEN
+# Autologon if a token is present in environment variables
+$envVar = Get-ChildItem -Path 'Env:' | Where-Object Name -In 'GH_TOKEN', 'GITHUB_TOKEN' | Select-Object -First 1
+$envVarPresent = $envVar.count -gt 0
+if ($envVarPresent) {
+    Connect-GitHubAccount
 }

src/GitHub/GitHub.psm1

@@ -6,28 +6,27 @@ Write-Verbose "[$scriptName] - Importing module"
 
 #region - Importing data files
 Write-Verbose "[$scriptName] - [data] - Processing folder"
-$dataFolder = (Join-Path $PSScriptRoot 'data')
-Write-Verbose "[$scriptName] - [data] - [$dataFolder]"
-Get-ChildItem -Path "$dataFolder" -Recurse -Force -Include '*.psd1' | ForEach-Object {
+$dataFolder = Join-Path $PSScriptRoot 'data'
+Get-ChildItem -Path $dataFolder -Recurse -Force -Include '*.psd1' -ErrorAction SilentlyContinue | ForEach-Object {
     Write-Verbose "[$scriptName] - [data] - [$($_.Name)] - Importing data file"
     New-Variable -Name $_.BaseName -Value (Import-PowerShellDataFile -Path $_.FullName) -Force
     Write-Verbose "[$scriptName] - [data] - [$($_.Name)] - Done"
 }
 Write-Verbose "[$scriptName] - [data] - Done"
-#endregion - Importing datas
+#endregion - Importing data files
 
 #region - Importing script files
 $folders = 'init', 'classes', 'private', 'public'
 foreach ($folder in $folders) {
     Write-Verbose "[$scriptName] - [$folder] - Processing folder"
-    $folderPath = Join-Path -Path $PSScriptRoot -ChildPath $folder
+    $folderPath = Join-Path $PSScriptRoot $folder
     if (Test-Path -Path $folderPath) {
-        $files = Get-ChildItem -Path $folderPath -Include '*.ps1', '*.psm1' -Recurse | Sort-Object -Property FullName
-        foreach ($file in $files) {
-            Write-Verbose "[$scriptName] - [$folder] - [$($file.Name)] - Importing script file"
-            Import-Module $file -Verbose:$false
-            Write-Verbose "[$scriptName] - [$folder] - [$($file.Name)] - Done"
-        }
+        Get-ChildItem -Path $folderPath -Include '*.ps1', '*.psm1' -Recurse |
+            Sort-Object -Property FullName | ForEach-Object {
+                Write-Verbose "[$scriptName] - [$folder] - [$($_.Name)] - Importing script file"
+                Import-Module $_ -Verbose:$false
+                Write-Verbose "[$scriptName] - [$folder] - [$($_.Name)] - Done"
+            }
     }
     Write-Verbose "[$scriptName] - [$folder] - Done"
 }
@@ -44,7 +43,7 @@ Write-Verbose "[$scriptName] - [Root] - Done"
 #endregion - Importing root script files
 
 #region Export module members
-$foldersToProcess = Get-ChildItem -Path $PSScriptRoot -Directory | Where-Object -Property Name -In $folders
+$foldersToProcess = Get-ChildItem -Path $PSScriptRoot -Directory | Where-Object Name -In $folders
 $moduleFiles = $foldersToProcess | Get-ChildItem -Include '*.ps1' -Recurse -File -Force
 $functions = $moduleFiles.BaseName
 $param = @{
@@ -54,9 +53,9 @@ $param = @{
     Alias    = '*'
 }
 
-Write-Verbose 'Exporting module members'
-
+Write-Verbose "[$scriptName] - Exporting module members"
 Export-ModuleMember @param
+Write-Verbose "[$scriptName] - Exporting module members - Done"
 #endregion Export module members
 
 Write-Verbose "[$scriptName] - Done"

src/GitHub/data/SecretVault.psd1

@@ -1,7 +1,5 @@
 @{
-    Name   = 'GitHub'                           # $script:SecretVault.Name
+    Name   = 'SecretStore'                      # $script:SecretVault.Name
     Type   = 'Microsoft.PowerShell.SecretStore' # $script:SecretVault.Type
-    Secret = @{
-        Name = 'Config'                           # $script:SecretVault.Secret.Name
-    }
+    Prefix = 'GHPS_'                            # $script:SecretVault.Prefix
 }

src/GitHub/en_US/about_Config.help.txt

@@ -53,8 +53,6 @@ FUNCTIONS
 
     - Get-GitHubConfig: Fetches the current module configuration.
     - Reset-GitHubConfig: Resets all or specific sections to its default values.
-    - Restore-GitHubConfig: Restores the configuration from the secret vault.
-    - Save-GitHubConfig: Saves the current configuration to the secret vault.
     - Set-GitHubConfig: Allows setting specific elements of the configuration.
 
 CONFIGURATION
@@ -87,21 +85,10 @@ EXAMPLES
 
     -------------------------- EXAMPLE 3 --------------------------
 
-    Restore-GitHubConfig
+    Reset-GitHubConfig -Scope Auth
 
-    This command restores the GitHub configuration from the secret vault.
+    This command resets the Auth related settings of the GitHub configuration to its default values.
 
-    -------------------------- EXAMPLE 4 --------------------------
-
-    Reset-GitHubConfig -Scope 'App.API'
-
-    This command resets the 'App.API' section of the GitHub configuration to its default values.
-
-    -------------------------- EXAMPLE 5 --------------------------
-
-    Save-GitHubConfig
-
-    This command saves the current GitHub configuration to the secret vault.
 
 KEYWORDS
 

src/GitHub/private/Auth/DeviceFlow/Check-GitHubAccessToken.ps1

@@ -33,7 +33,7 @@
 
         # The refresh token to use for re-authentication.
         [Parameter()]
-        [string] $RefreshToken
+        [securestring] $RefreshToken
     )
 
     do {

src/GitHub/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1

@@ -35,7 +35,7 @@
             Mandatory,
             ParameterSetName = 'RefreshToken'
         )]
-        [string] $RefreshToken
+        [securestring] $RefreshToken
     )
 
     $body = @{
@@ -44,7 +44,7 @@
 
     if ($PSBoundParameters.ContainsKey('RefreshToken')) {
         $body += @{
-            'refresh_token' = $RefreshToken
+            'refresh_token' = (ConvertFrom-SecureString $RefreshToken -AsPlainText)
             'grant_type'    = 'refresh_token'
         }
     }
@@ -67,6 +67,8 @@
         Write-Verbose ($RESTParams.GetEnumerator() | Out-String)
 
         $tokenResponse = Invoke-RestMethod @RESTParams -Verbose:$false
+
+        Write-Verbose ($tokenResponse | ConvertTo-Json | Out-String)
         return $tokenResponse
     } catch {
         Write-Error $_

src/GitHub/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1

@@ -56,4 +56,3 @@
         throw $_
     }
 }
-

src/GitHub/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1

@@ -38,7 +38,7 @@
             Mandatory,
             ParameterSetName = 'RefreshToken'
         )]
-        [string] $RefreshToken,
+        [securestring] $RefreshToken,
 
         # The interval to wait between polling for the token.
         [Parameter()]