Merge branch 'main' into bugfix/readme

Author: bryanbcook

.github/workflows/pester-tests.yml

@@ -3,8 +3,6 @@ name: Pester Tests
 on:
   pull_request:
     branches: [ main ]
-  push:
-    branches: [ main ]
 
 jobs:
   pester-tests:

.github/workflows/publish.yml

@@ -186,6 +186,18 @@ jobs:
         if ($testResults.FailedCount -gt 0) {
           throw "Tests failed. Cannot publish to PowerShell Gallery."
         }
+
+    - name: Inject Values into Module
+      shell: pwsh
+      env:
+        CLIENT_ID: ${{ secrets.GOOGLE_CLIENT_ID }}
+        CLIENT_SECRET: ${{ secrets.GOOGLE_CLIENT_SECRET }}
+      run: |
+        $file = "./src/public/Initialize-Blogger.ps1"
+        $content = Get-Content $file -Raw
+        $content = $content -replace "<<CLIENT_ID>>", $env:CLIENT_ID
+        $content = $content -replace "<<CLIENT_SECRET>>", $env:CLIENT_SECRET
+        $content | Set-Content -Path $file -Force
     
     - name: Publish to PowerShell Gallery
       shell: pwsh
@@ -274,45 +286,19 @@ jobs:
           Write-Host "Created and pushed tag v${{ steps.version.outputs.version }}"
         }
     
-    - name: Get Commit Messages for Release Notes
-      if: steps.run-mode.outputs.is-dry-run == 'false'
-      id: release-notes
-      shell: pwsh
-      run: |
-        # Get the previous tag
-        $previousTag = git describe --tags --abbrev=0 "v${{ steps.version.outputs.version }}~1" 2>$null
-        if ($LASTEXITCODE -ne 0) {
-          # If no previous tag, get last 10 commits
-          $commits = git log --oneline --pretty=format:"- %s (%h)" -n 10
-        } else {
-          # Get commits since the previous tag
-          $commits = git log --oneline --pretty=format:"- %s (%h)" "$previousTag..v${{ steps.version.outputs.version }}"
-        }
-        
-        $releaseNotes = @"
-        ## Changes in version ${{ steps.version.outputs.version }}
-        
-        $($commits -join "`n")
-        
-        ## Installation
-        ``````powershell
-        Install-Module -Name PSBlogger -RequiredVersion ${{ steps.version.outputs.version }}
-        ``````
-        "@
-        
-        # Escape for GitHub Actions
-        $releaseNotes = $releaseNotes -replace "`r`n", "`n" -replace "`n", "%0A"
-        echo "release-notes=$releaseNotes" >> $env:GITHUB_OUTPUT
-    
     - name: Create GitHub Release
       if: steps.run-mode.outputs.is-dry-run == 'false'
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: softprops/action-gh-release@v2
       with:
         tag_name: v${{ steps.version.outputs.version }}
-        release_name: Release v${{ steps.version.outputs.version }}
-        body: ${{ steps.release-notes.outputs.release-notes }}
+        name: Release v${{ steps.version.outputs.version }}
+        generate_release_notes: true
+        append_body: true
+        body: |
+          ## Installation
+          ```powershell
+          Install-Module -Name PSBlogger -RequiredVersion ${{ steps.version.outputs.version }}
+          ```
         draft: false
         prerelease: false
 

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contribution Guide
+
+## Environment Setup
+
+### Tools
+
+Local development requires the following:
+
+- PowerShell 7.x
+- Pester 5.7.1
+- [Pandoc](https://pandoc.org)
+- Visual Studio Code, with the following extensions:
+  - Test Adapter Converter
+  - Test Explorer UI
+  - Pester Tests
+
+Development is presently done on Windows 11, though conceptually it should work on Linux
+
+### Codespace
+
+As an alternative to local development environments, a GitHub Codespace can be used to build and test. Codespace usage has an [associated cost](https://docs.github.com/en/billing/concepts/product-billing/github-codespaces). The free option should be sufficient for most developers.
+
+Codespaces are Linux based and require the above tools to be installed.
+
+TODO: DevContainer configuration with tools installed is pending.
+
+### Google Application
+
+The environment uses a Google Application with the following setup. The published module has credentials defined, but if you may want to create an application for local testing purposes.
+
+While this is not a fully documented walk-through on how to create a Google Application in the [Developer Console](https://console.cloud.google.com), the application has the following details.
+
+- Branding:
+  - An app name + support email
+- Audience: Testing
+- Clients:
+  - Web Application
+  - Authorized redirect URIs:
+    - <http://localhost/oauth2callback>
+    - <https://localhost:8040/oauth2callback>
+- Data Access: uses the following scopes:
+
+- <https://www.googleapis.com/auth/blogger>: manage blogger account and posts
+- <https://www.googleapis.com/auth.drive.file>: upload and manage files into Google Drive that are scoped to the application.
+
+For local testing, you'll need the Client ID and Client Secret
+
+## Running Locally
+
+Within Visual Studio Code, you should be able to run the tests with no additional configuration.
+
+To test the module manually, you will need to provide your client-id and client-secret as environment variables.
+
+```shell
+cd ./src
+./reload.ps1 # to load the source into memory
+
+$env:PSBLOGGER_CLIENT_ID = "<your-id>"
+$env:PSBLOGGER_CLIENT_SECRET = "<your-secret>"
+
+Initialize-Blogger
+```

README.md

@@ -14,7 +14,6 @@ A PowerShell library for publishing markdown files authored in markdown to Blogg
    choco install pandoc
    ```
 
-   (Future: still need to publish to PowerShell nuget library)
    ```
    Install-Module PSBlogger
    ```

src/PSBlogger.psd1

@@ -5,7 +5,7 @@
 RootModule = 'PSBlogger.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.2.0'
+ModuleVersion = '0.9.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -20,7 +20,7 @@ Author = 'Bryan Cook'
 CompanyName = 'Bryan Cook'
 
 # Copyright statement for this module
-Copyright = '#169; me'
+# Copyright = '#169; me'
 
 # Description of the functionality provided by this module
 Description = 'Module to publish markdown files to Blogger'
@@ -97,16 +97,16 @@ PrivateData = @{
         Tags = 'blogger','markdown','pandoc'
 
         # A URL to the license for this module.
-        #LicenseUri = ''
+        LicenseUri = 'https://github.com/bryanbcook/PSBlogger?tab=MIT-1-ov-file#readme'
 
         # A URL to the main website for this project.
-        ProjectUri = 'http://www.bryancook.net/'
+        ProjectUri = 'https://github.com/bryanbcook/PSBlogger'
 
         # A URL to an icon representing this module.
         #IconUri = ''
 
         # ReleaseNotes of this module
-        #ReleaseNotes = ''
+        ReleaseNotes = 'https://github.com/bryanbcook/PSBlogger/releases'
         # Prerelease string of this module
         # Prerelease = ''
 

src/private/AuthWebServer.ps1

@@ -13,36 +13,60 @@ Function Wait-GoogleAuthApiToken
     $HttpListener.Start()
 
     $authCodeReceived = $False
-  
+
     while ($HttpListener.IsListening -and -not $authCodeReceived) {
-      $HttpContext = $HttpListener.GetContext()
-      $HttpRequest = $HttpContext.Request      
-      $Query = $HttpRequest.QueryString
+      # Use async method with timeout to allow for cancellation
+      $contextTask = $HttpListener.GetContextAsync()
+      
+      # Wait for either a request or cancellation (check every 500ms)
+      while (-not $contextTask.IsCompleted) {
+        Start-Sleep -Milliseconds 500
+        
+        # Check if user pressed Ctrl+C by testing if we can write to console
+        try {
+          [Console]::TreatControlCAsInput = $false
+          if ([Console]::KeyAvailable) {
+            $key = [Console]::ReadKey($true)
+            if ($key.Key -eq 'C' -and $key.Modifiers -eq 'Control') {
+              Write-Information "`nCancellation requested. Stopping auth server..."
+              return $null
+            }
+          }
+        }
+        catch {
+          # Ignore console access errors
+        }
+      }
+      
+      if ($contextTask.IsCompleted) {
+        $HttpContext = $contextTask.Result
+        $HttpRequest = $HttpContext.Request      
+        $Query = $HttpRequest.QueryString
 
-      if ($null -ne $Query["code"]) {
-        $authCode = $Query["code"]
-        Write-Output $authCode
-        Write-Verbose "Received auth-code: $authCode"
-        $authCodeReceived = $true
+        if ($null -ne $Query["code"]) {
+          $authCode = $Query["code"]
+          Write-Output $authCode
+          Write-Verbose "Received auth-code: $authCode"
+          $authCodeReceived = $true
 
-        # Send "Thanks!"
-        $buffer = [System.Text.Encoding]::UTF8.GetBytes("<html><body>Good Job! Successfully authorized PSBlogger. You can close this browser window now.</body></html>")
-        $response = $HttpContext.Response
-        $response.ContentLength64 = $buffer.Length
-        $output = $response.OutputStream;
-        $output.Write($buffer,0,$buffer.Length)
-        $output.Close() | Write-Verbose 
-      }      
+          # Send "Thanks!"
+          $buffer = [System.Text.Encoding]::UTF8.GetBytes("<html><body>Good Job! Successfully authorized PSBlogger. You can close this browser window now.</body></html>")
+          $response = $HttpContext.Response
+          $response.ContentLength64 = $buffer.Length
+          $output = $response.OutputStream;
+          $output.Write($buffer,0,$buffer.Length)
+          $output.Close() | Write-Verbose 
+        }
+      }
     }
-  
     Write-Verbose "Stopping HttpListener."
     $HttpListener.Stop()
     Write-Verbose "Stopped HttpListener."
   }
   catch {
     # TODO: Catch Permission denied error and warn about running from an elevated prompt
     # or add Requires -Administrator
-    Write-Error $_.ToString()
+    Write-Error $_.ToString() -ErrorAction Stop
   }
   finally {
     if ($null -ne $HttpListener) {

src/private/Get-AuthHeader.ps1

@@ -4,7 +4,13 @@ function Get-AuthHeader()
 
     if (!(Test-GoogleAccessToken $BloggerSession.AccessToken))
     {
-        $token = Update-GoogleAccessToken -refreshToken $BloggerSession.RefreshToken
+        $credentialCache = Get-CredentialCache
+        $updateArgs = @{
+            clientId = $credentialCache.client_id
+            clientSecret = $credentialCache.client_secret
+            refreshToken = $BloggerSession.RefreshToken
+        }
+        $token = Update-GoogleAccessToken @updateArgs
         Update-CredentialCache -token $token
     }
 

src/private/GoogleAccessToken.ps1

@@ -4,11 +4,11 @@ function Get-GoogleAccessToken
         [Parameter(Mandatory=$true)]
         [string]$code,
 
-        [Parameter()]
-        [string]$clientId = "284606892422-ribvo7oodlbtd70e8onn8rg4hm58mluj.apps.googleusercontent.com",
+        [Parameter(Mandatory=$true)]
+        [string]$clientId,
 
-        [Parameter()]
-        [string]$clientSecret = "PUK0j9ig-GHcSByQao2i1aIa",
+        [Parameter(Mandatory=$true)]
+        [string]$clientSecret,
 
         [Parameter()]
         [string]$redirectUri = "http://localhost/oauth2callback"
@@ -39,10 +39,10 @@ function Update-GoogleAccessToken
 {
     param(
         [Parameter()]
-        [string]$clientId = "284606892422-ribvo7oodlbtd70e8onn8rg4hm58mluj.apps.googleusercontent.com",
+        [string]$clientId,
 
         [Parameter()]
-        [string]$clientSecret = "PUK0j9ig-GHcSByQao2i1aIa",
+        [string]$clientSecret,
 
         [Parameter()]
         [string]$refreshToken

src/private/ModuleInitHelpers.ps1

@@ -0,0 +1,60 @@
+function Test-IsAdmin
+{
+  $currentIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
+  $principal = New-Object System.Security.Principal.WindowsPrincipal($currentIdentity)
+  return $principal.IsInRole([System.Security.Principal.WindowsBuiltInRole]::Administrator)
+}
+
+function Test-PandocInstalled {
+  [CmdletBinding()]
+  [OutputType([bool])]
+  param()
+
+  try {
+    $null = Get-Command pandoc -ErrorAction Stop
+    Write-Verbose "Pandoc is installed and available in PATH"
+    return $true
+  }
+  catch {
+    Write-Verbose "Pandoc is not installed or not available in PATH"
+    return $false
+  }
+}
+
+function Test-ChocolateyInstalled {
+  [CmdletBinding()]
+  [OutputType([bool])]
+  param()
+  
+  try {
+    $null = Get-Command choco -ErrorAction Stop
+    Write-Verbose "Chocolatey is installed and available in PATH"
+    return $true
+  }
+  catch {
+    Write-Verbose "Chocolatey is not installed or not available in PATH"
+    return $false
+  }
+}
+
+function Install-PandocWithChocolatey {
+  [CmdletBinding()]
+  param()
+  
+  Write-Information "Installing Pandoc using Chocolatey..."
+  
+  try {
+    $process = Start-Process choco -ArgumentList "install", "pandoc", "-y" -NoNewWindow -Wait -PassThru
+    
+    if ($process.ExitCode -eq 0) {
+      Write-Information "Pandoc installation completed successfully."
+      Write-Information "You may need to restart your PowerShell session for Pandoc to be available in PATH."
+    }
+    else {
+      Write-Error "Pandoc installation failed with exit code: $($process.ExitCode)"
+    }
+  }
+  catch {
+    Write-Error "Failed to install Pandoc: $($_.Exception.Message)"
+  }
+}