feat: add function to get public IP address (#12)

danstis · web-flow · commit 038b957519e4 · 2021-05-31T18:23:25.000+10:00
* Add function to get public IP address Fixes #11
diff --git a/PSF.psd1 b/PSF.psd1
@@ -69,7 +69,7 @@
 	# 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-oAuthToken', 'Get-RandomPassword', 'Get-WiFiKnownPasswords')
+	FunctionsToExport = @('Get-oAuthToken', 'Get-RandomPassword', 'Get-WiFiKnownPasswords', 'Get-PublicIP')
 
 	# 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   = @()
@@ -78,7 +78,7 @@
 	# VariablesToExport = @()
 
 	# Aliases 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 aliases to export.
-	AliasesToExport   = @('gpw')
+	AliasesToExport   = @('gpw', 'gpip', 'Get-PublicIPAddress')
 
 	# DSC resources to export from this module
 	# DscResourcesToExport = @()
diff --git a/PSF.psm1 b/PSF.psm1
@@ -3,3 +3,4 @@
 . $PSScriptRoot\functions\Get-oAuthToken.ps1
 . $PSScriptRoot\functions\Get-RandomPassword.ps1
 . $PSScriptRoot\functions\Get-WiFiKnownPasswords.ps1
+. $PSScriptRoot\functions\Get-PublicIP.ps1
diff --git a/functions/Get-PublicIP.ps1 b/functions/Get-PublicIP.ps1
@@ -0,0 +1,45 @@
+function Get-PublicIP {
+	<#
+	.SYNOPSIS
+		Returns the public IP address for the connected network.
+	.DESCRIPTION
+		Uses the ipify.org API to lookup the Public IP address.
+		The function will return the Public IP as well as copy it to your clipboard.
+	.EXAMPLE
+		C:\PS> Get-PublicIP
+		Returns the current IPv4 Public IP for the connected network.
+	.EXAMPLE
+		C:\PS> Get-PublicIP -v6
+		Returns the current IPv6 (if available) Public IP for the connected network.
+	.OUTPUTS
+		Public IP address(es)
+	.NOTES
+		Version 1.0.0
+	#>
+	[CmdletBinding()]
+	param (
+		# IPv6 switch
+		[Parameter(Mandatory = $false, HelpMessage = 'Perform an IPv6 lookup')]
+		[switch] $v6
+	)
+
+	begin {
+		$ErrorActionPreference = 'Stop'
+		$Uri = 'https://api.ipify.org?format=json'
+		if ($6) {
+			$Uri = 'https://api64.ipify.org?format=json'
+		}
+	}
+
+	process {
+		$resp = (Invoke-WebRequest $Uri -ErrorAction 'stop').Content | ConvertFrom-Json
+	}
+
+	end {
+		$resp.ip | clip
+		return $resp.ip
+	}
+}
+
+New-Alias -Name gpip -Value Get-PublicIP
+New-Alias -Name Get-PublicIPAddress -Value Get-PublicIP
