Adds Get-TeamViewerPolicy utility script

Author: danieljoos

Get-TeamViewerPolicy/Get-TeamViewerPolicy.Tests.ps1

@@ -0,0 +1,63 @@
+# Copyright (c) 2019 TeamViewer GmbH
+# See file LICENSE.txt
+
+$here = Split-Path -Parent $MyInvocation.MyCommand.Path
+$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path) -replace '\.Tests\.', '.'
+. "$here\$sut" -ApiToken "test" -InformationAction SilentlyContinue
+
+Describe 'Get-TeamViewerPolicy' {
+    Mock Invoke-WebRequest { @{Content = '{"policies": [
+        {"policy_id": "foo", "name": "bar", "settings": {}},
+        {"policy_id": "hello", "name": "world", "settings": {}}
+    ]}'} }
+
+    It 'Should call the "teamviewerpolicies" Web API endpoint' {
+        Get-TeamViewerPolicy 'TestToken'
+        Assert-MockCalled Invoke-WebRequest -Times 1 -Scope It -ParameterFilter {
+            $Uri -And [System.Uri]$Uri.PathAndQuery -eq '/api/v1/teamviewerpolicies' -And
+            $Method -And $Method -eq 'Get' -And -Not $Body
+        }
+    }
+
+    It 'Should set the authorization header' {
+        Get-TeamViewerPolicy 'TestToken'
+        Assert-MockCalled Invoke-WebRequest -Times 1 -Scope It -ParameterFilter {
+            $Headers -And $Headers.ContainsKey('authorization') -And `
+                $Headers.authorization -eq 'Bearer TestToken'
+        }
+    }
+
+    It 'Should filter-out policy ID and name' {
+        $result = (Get-TeamViewerPolicy 'TestToken')
+        $result | Should -HaveCount 2
+        $result[0].PSObject.Properties | Should -HaveCount 2
+        $result[0].policy_id | Should -Be "foo"
+        $result[0].name | Should -Be "bar"
+        $result[1].PSObject.Properties | Should -HaveCount 2
+        $result[1].policy_id | Should -Be "hello"
+        $result[1].name | Should -Be "world"
+    }
+}
+
+Describe 'ConvertTo-TeamViewerRestError' {
+    It 'Should convert from JSON' {
+        $result = ('{"foo": "bar"}' | ConvertTo-TeamViewerRestError)
+        $result.foo | Should -Be 'bar'
+    }
+
+    It 'Should return input object for invalid JSON' {
+        $result = ('garbage' | ConvertTo-TeamViewerRestError)
+        $result | Should -Be 'garbage'
+    }
+}
+
+Describe 'Invoke-TeamViewerRestMethod' {
+    Mock Invoke-WebRequest { @{Content = '{"foo": "bar"}'} }
+
+    It 'Should call Invoke-WebRequest and convert the result from JSON' {
+        $result = Invoke-TeamViewerRestMethod -Uri 'http://example.test'
+        $result.foo | Should -Be 'bar'
+        Assert-MockCalled Invoke-WebRequest `
+            -ParameterFilter { $Uri -eq 'http://example.test' }-Times 1 -Scope It
+    }
+}

Get-TeamViewerPolicy/Get-TeamViewerPolicy.ps1

@@ -0,0 +1,64 @@
+<#
+ .SYNOPSIS
+    Get a list of TeamViewer policies.
+
+ .DESCRIPTION
+    The script fetches TeamViewer policies for the account that corresponds
+    to the given API token.
+    It outputs the policy ID and name.
+    Use this script in conjunction with the `Set-TeamViewerDevicesPolicy`
+    example script to set the policy of certain devices.
+
+ .PARAMETER ApiToken
+    The TeamViewer API token to use.
+    The token requires the following access permissions:
+        - `View TeamViewer policies`
+
+ .EXAMPLE
+    .\Get-TeamViewerPolicy.ps1
+
+ .NOTES
+    Copyright (c) 2019 TeamViewer GmbH
+    See file LICENSE.txt
+    Version 1.0.0
+#>
+
+param(
+    [Parameter(Mandatory = $true)]
+    [string] $ApiToken
+)
+
+if (-Not $MyInvocation.BoundParameters.ContainsKey('ErrorAction')) { $script:ErrorActionPreference = 'Stop' }
+if (-Not $MyInvocation.BoundParameters.ContainsKey('InformationAction')) { $script:InformationPreference = 'Continue' }
+
+$tvApiVersion = 'v1'
+$tvApiBaseUrl = 'https://webapi.teamviewer.com'
+
+function ConvertTo-TeamViewerRestError {
+    param([parameter(ValueFromPipeline)]$err)
+    try { return ($err | Out-String | ConvertFrom-Json) }
+    catch { return $err }
+}
+
+function Invoke-TeamViewerRestMethod {
+    # Using `Invoke-WebRequest` instead of `Invoke-RestMethod`:
+    # There is a known issue for PUT and DELETE operations to hang on Windows Server 2012.
+    try { return ((Invoke-WebRequest -UseBasicParsing @args).Content | ConvertFrom-Json) }
+    catch [System.Net.WebException] {
+        $stream = $_.Exception.Response.GetResponseStream()
+        $reader = New-Object System.IO.StreamReader($stream)
+        $reader.BaseStream.Position = 0
+        Throw ($reader.ReadToEnd() | ConvertTo-TeamViewerRestError)
+    }
+}
+
+function Get-TeamViewerPolicy($accessToken) {
+    return Invoke-TeamViewerRestMethod -Uri "$tvApiBaseUrl/api/$tvApiVersion/teamviewerpolicies" `
+        -Method Get -Headers @{authorization = "Bearer $accessToken"} | `
+        Select-Object -ExpandProperty 'policies' |
+        Select-Object -Property 'name','policy_id'
+}
+
+if ($MyInvocation.InvocationName -ne '.') {
+    Get-TeamViewerPolicy $ApiToken
+}