Added New-WattTimeAccount function

Author: webtonize

README.md

@@ -27,34 +27,42 @@ For a real-world solution with a commercial data provider, check out
 the [carbon-aware-sdk](https://github.com/Green-Software-Foundation/carbon-aware-sdk)
 by the [Green Software Foundation](https://greensoftware.foundation/)
 
-This module is supplied as-is at the moment and not (yet)
-published through _PSGallery_.
-
 ### Usage
 
 #### PowerShell Module
 
 To get started with this module you will need an account on
 [WattTime](https://www.watttime.org/). See
 [the manual](https://www.watttime.org/api-documentation/#register-new-user)
-on registering an account. NOTE: You can only register via the API.
-Currently no GUI exists for registration.
+on registering an account. The module provides a function `New-WattTimeAccount`
+to create an account if you do not yet have one.
 
 You will also need the _Az.Resources_ PowerShell Module for Azure installed
 and connected to your Azure account. See
 [the installation manual](https://learn.microsoft.com/en-us/powershell/azure/install-az-ps)
 for the _Az_ module for instructions.
 
-Import the module from a clone of this repository:
+To install the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/PSWattTime/).
+
+```powershell
+Install-Module -Name PSWattTime
+```
+
+To register an account with _WattTime_:
 
 ```powershell
-Import-Module .\src\PSWattTime
+New-WattTimeAccount -Username <YOUR_USERNAME> `
+  -Password '<YOUR_PASSWORD>' `
+  -Email '<you@domain.com>' `
+  -Organization <YOUR_ORGANIZATION>
 ```
 
+
 Authenticate to the _WattTime_ API:
 
 ```powershell
- $token = Get-WattTimeAuthToken -Username '<YOUR_WATTTIME_USERNAME>' -Password '<YOUR_WATTTIME_PASSWORD>'
+ $token = Get-WattTimeAuthToken -Username '<YOUR_WATTTIME_USERNAME>' `
+  -Password '<YOUR_WATTTIME_PASSWORD>'
 ```
 
 Get current percentage of energy with emissions the 'westeurope' Azure region:

src/PSWattTime/PSWattTime.psd1

@@ -12,7 +12,7 @@
 RootModule = 'PSWattTime.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.0.1.0'
+ModuleVersion = '1.0.2.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -30,7 +30,7 @@ CompanyName = 'Unknown'
 Copyright = '(c) Roderick Bant. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'Simple PowerShell interface getting WattTime emissions data for Azure regions'
+Description = 'Simple PowerShell interface for getting WattTime emissions data for Azure regions'
 
 # Minimum version of the PowerShell engine required by this module
 # PowerShellVersion = ''
@@ -69,7 +69,14 @@ RequiredModules = @('Az.Resources')
 # 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 = @('Get-WattTime', 'Get-WattTimeAuthToken', 'ConvertFrom-AzureRegion', 'Get-WattTimeForAzureRegion', 'Get-AzureRegionWithLowestWattTime')
+FunctionsToExport = @(
+        'Get-WattTime',
+        'Get-WattTimeAuthToken',
+        'ConvertFrom-AzureRegion',
+        'Get-WattTimeForAzureRegion',
+        'Get-AzureRegionWithLowestWattTime',
+        'New-WattTimeAccount'
+    )
 
 # 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 = @()
@@ -107,7 +114,7 @@ PrivateData = @{
         # IconUri = ''
 
         # ReleaseNotes of this module
-        ReleaseNotes = 'Initial PSWattTime Release'
+        ReleaseNotes = 'Added New-WattTimeAccount function for registering a new WattTime account'
 
         # Prerelease string of this module
         # Prerelease = ''
@@ -123,10 +130,9 @@ PrivateData = @{
 } # End of PrivateData hashtable
 
 # HelpInfo URI of this module
-# HelpInfoURI = ''
+HelpInfoURI = ''
 
 # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
 # DefaultCommandPrefix = ''
 
 }
-

src/PSWattTime/PSWattTime.psm1

@@ -166,5 +166,59 @@ function Get-AzureRegionWithLowestWattTime {
     $wattTime | Sort-Object -Property percent | Select-Object -First 1
 }
 
-Export-ModuleMember -Function Get-WattTimeAuthToken, Get-WattTime, ConvertFrom-AzureRegion, Get-WattTimeForAzureRegion, Get-AzureRegionWithLowestWattTime
+<#
+    .SYNOPSIS
+    Create a new WattTime account
+
+    .DESCRIPTION
+    Creates a new PSWattTime account with the specified username,
+    password, email and organization
+
+    .PARAMETER Username
+    The username for the new account
+
+    .PARAMETER Password
+    The password for the new account
+
+    .PARAMETER Email
+    The email address for the new account
+
+    .PARAMETER Organization
+    The organization for the new account
+
+    .EXAMPLE
+    New-WattTimeAccount -Username 'username' -Password 'password' -Email 'email' -Organization 'organization'
+#>
+function New-WattTimeAccount {
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory=$true)]
+        [string]$Username,
+        [Parameter(Mandatory=$true)]
+        [string]$Password,
+        [Parameter(Mandatory=$true)]
+        [string]$Email,
+        [Parameter(Mandatory=$true)]
+        [string]$Organization
+    )
+    $headers = @{
+        'Content-Type' = 'application/json'
+    }
+    $body = @{
+        username = $Username
+        password = $Password
+        email = $Email
+        org = $Organization
+    }
+    $bodyJson = $body | ConvertTo-Json
+    $response = Invoke-RestMethod -Uri 'https://api2.watttime.org/v2/register/' -Method Post -Headers $headers -Body $bodyJson -ContentType 'application/json'
+    return $response
+}
 
+Export-ModuleMember -Function `
+    Get-WattTimeAuthToken, `
+    Get-WattTime, `
+    ConvertFrom-AzureRegion, `
+    Get-WattTimeForAzureRegion, `
+    Get-AzureRegionWithLowestWattTime, `
+    New-WattTimeAccount