Merge pull request #20 from Readify/ticket-comments

Adds `Invoke-CommentRedaction` and other comment function updates
Readify · Feb 19, 2020 · 5b96eb7 · 5b96eb7
2 parents 156cdf3 + c861d94
commit 5b96eb7
Show file tree

Hide file tree

Showing 5 changed files with 171 additions and 3 deletions.
diff --git a/PwshZendesk.psd1 b/PwshZendesk.psd1
@@ -104,6 +104,7 @@
         'Get-UserRelated',                     'Get-ZendeskUserRelated'
         'Hide-Comment',                        'Hide-ZendeskComment'
         'Import-Ticket',                       'Import-ZendeskTicket'
+        'Invoke-CommentRedaction',             'Invoke-ZendeskCommentRedaction'
         'Invoke-Method',                       'Invoke-ZendeskMethod'
         'Merge-Ticket',                        'Merge-ZendeskTicket'
         'Merge-User',                          'Merge-ZendeskUser'

diff --git a/functions/Get-Comment.ps1 b/functions/Get-Comment.ps1
@@ -18,6 +18,8 @@ function Get-Comment {
         $Context = $null
     )
 
+    Assert-IsAgent -Context $Context
+
     $path = "/api/v2/tickets/$TicketId/comments.json"
 
     $result = Invoke-Method -Context $Context -Path $path -Verbose:$VerbosePreference

diff --git a/functions/Hide-Comment.ps1 b/functions/Hide-Comment.ps1
@@ -2,7 +2,7 @@
 function Hide-Comment {
 
     [OutputType([String])]
-    [CmdletBinding()]
+    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
     Param (
 
         # Unique Id of the comment to hide
@@ -24,8 +24,12 @@ function Hide-Comment {
         $Context = $null
     )
 
+    Assert-IsAgent -Context $Context
+
     $path = "/api/v2/tickets/$TicketId/comments/$Id/make_private.json"
 
-    $result = Invoke-Method -Context $Context -Method 'Put' -Path $path -Verbose:$VerbosePreference
-    $result
+    if ($PSCmdlet.ShouldProcess($Id, 'Make comment private')) {
+        $result = Invoke-Method -Context $Context -Method 'Put' -Path $path -Verbose:$VerbosePreference
+        $result
+    }
 }
diff --git a/functions/Invoke-CommentRedaction.ps1 b/functions/Invoke-CommentRedaction.ps1
@@ -0,0 +1,44 @@
+
+function Invoke-CommentRedaction {
+
+    [OutputType([PSCustomObject])]
+    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
+    Param (
+
+        # Unique Id of the ticket the comment belongs to
+        [Parameter(Mandatory = $true)]
+        [ValidateRange(1, [Int64]::MaxValue)]
+        [Int64]
+        $TicketId,
+
+        # Unique Id of the comment to redact text in
+        [Parameter(Mandatory = $true)]
+        [ValidateRange(1, [Int64]::MaxValue)]
+        [Int64]
+        $Id,
+
+        # Text to redact
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [String]
+        $Text,
+
+        # Zendesk Connection Context from `Get-ZendeskConnection`
+        [Parameter(Mandatory = $false)]
+        [PSTypeName('ZendeskContext')]
+        [PSCustomObject]
+        $Context = $null
+    )
+
+    Assert-IsAgent -Context $Context
+
+    $path = "/api/v2/tickets/$TicketId/comments/$Id/redact.json"
+    $body = @{
+        text = $Text
+    }
+
+    if ($PSCmdlet.ShouldProcess($Id, 'Redact comment text')) {
+        $result = Invoke-Method -Context $Context -Method 'Put' -Path $path -Body $body -Verbose:$VerbosePreference
+        $result
+    }
+}
diff --git a/tests/Routes-TicketComments.tests.ps1 b/tests/Routes-TicketComments.tests.ps1
@@ -0,0 +1,117 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
+Param()
+
+Import-Module "$PSScriptRoot/../PwshZendesk.psm1" -Force
+
+Describe 'Groups Routes' {
+
+    InModuleScope PwshZendesk {
+
+        $IsInteractive = [Environment]::GetCommandLineArgs() -join ' ' -notmatch '-NonI'
+
+        $context = @{
+            Organization = 'company'
+            BaseUrl      = 'https://company.testdesk.com'
+            Credential   = [System.Management.Automation.PSCredential]::New('email', ('api-key' | ConvertTo-SecureString -AsPlainText -Force))
+            User         = [PSCustomObject]@{ role = '' }
+        }
+        $context | Add-Member -TypeName 'ZendeskContext'
+
+        Mock -ModuleName PwshZendesk Invoke-RestMethod { [PSCustomObject]@{ comment = $null; comments = $null } }
+
+        Context 'List Comments' {
+            It 'Matches the endpoint' {
+                if ($IsInteractive) {
+                    throw 'Please run test in non-interactive mode'
+                }
+
+                $context.User.role = 'admin'
+
+                { Get-Comment -Context $context -TicketId 1 } | Should -Not -Throw
+                Assert-MockCalled Invoke-RestMethod -Exactly 1 -ParameterFilter { $Method -eq 'Get' -and $Uri -match '/api/v2/tickets/\d+/comments\.json' } -Scope It
+            }
+
+            It 'Does not allow end users to call' {
+                $context.User.role = 'end-user'
+
+                { Get-Comment -Context $context -TicketId 1 } | Should -Throw 'Authenticated user must have role'
+            }
+
+            It 'Allows agents to call' {
+                $context.User.role = 'agent'
+
+                { Get-Comment -Context $context -TicketId 1 } | Should -Not -Throw
+            }
+
+            It 'Allows admins to call' {
+                $context.User.role = 'admin'
+
+                { Get-Comment -Context $context -TicketId 1 } | Should -Not -Throw
+            }
+        }
+
+        Context 'Redact String in Comment' {
+            It 'Matches the endpoint' {
+                if ($IsInteractive) {
+                    throw 'Please run test in non-interactive mode'
+                }
+
+                $context.User.role = 'admin'
+
+                { Invoke-CommentRedaction -Context $context -TicketId 1 -Id 2 -Text 'p@ssword' -confirm:$false } | Should -Not -Throw
+                Assert-MockCalled Invoke-RestMethod -Exactly 1 -ParameterFilter { $Method -eq 'Put' -and $Uri -match '/api/v2/tickets/\d+/comments/\d+/redact\.json' } -Scope It
+            }
+
+            It 'Does not allow end users to call' {
+                $context.User.role = 'end-user'
+
+                { Invoke-CommentRedaction -Context $context -TicketId 1 -Id 2 -Text 'p@ssword' -confirm:$false } | Should -Throw 'Authenticated user must have role'
+            }
+
+            It 'Allows agents to call' {
+                $context.User.role = 'agent'
+
+                { Invoke-CommentRedaction -Context $context -TicketId 1 -Id 2 -Text 'p@ssword' -confirm:$false } | Should -Not -Throw
+            }
+
+            It 'Allows admins to call' {
+                $context.User.role = 'admin'
+
+                { Invoke-CommentRedaction -Context $context -TicketId 1 -Id 2 -Text 'p@ssword' -confirm:$false } | Should -Not -Throw
+            }
+        }
+
+        Context 'Make Comment Private' {
+            It 'Matches the endpoint' {
+                if ($IsInteractive) {
+                    throw 'Please run test in non-interactive mode'
+                }
+
+                $context.User.role = 'admin'
+
+                { Hide-Comment -Context $context -TicketId 1 -Id 2 -Confirm:$false } | Should -Not -Throw
+                Assert-MockCalled Invoke-RestMethod -Exactly 1 -ParameterFilter { $Method -eq 'Put' -and $Uri -match '/api/v2/tickets/\d+/comments/\d+/make_private.json' } -Scope It
+            }
+
+            It 'Does not allow end users to call' {
+                $context.User.role = 'end-user'
+
+                { Hide-Comment -Context $context -TicketId 1 -Id 2 -Confirm:$false } | Should -Throw 'Authenticated user must have role'
+            }
+
+            It 'Allows agents to call' {
+                $context.User.role = 'agent'
+
+                { Hide-Comment -Context $context -TicketId 1 -Id 2 -Confirm:$false } | Should -Not -Throw
+            }
+
+            It 'Allows admins to call' {
+                $context.User.role = 'admin'
+
+                { Hide-Comment -Context $context -TicketId 1 -Id 2 -Confirm:$false } | Should -Not -Throw
+            }
+        }
+
+    }
+
+}