Merge pull request #59 from Sam-Martin/development

v1.2.4 - New-ServiceNowQuery Improvements

Author: Rick-2CA

Readme.md

@@ -1,6 +1,6 @@
 # ServiceNow
 
-[![GitHub release](https://img.shields.io/github/release/Sam-Martin/servicenow-powershell.svg)](https://github.com/Sam-Martin/servicenow-powershell/releases/latest) [![GitHub license](https://img.shields.io/github/license/Sam-Martin/servicenow-powershell.svg)](LICENSE) ![Test Coverage](https://img.shields.io/badge/coverage-80%25-yellow.svg)
+[![GitHub release](https://img.shields.io/github/release/Sam-Martin/servicenow-powershell.svg)](https://github.com/Sam-Martin/servicenow-powershell/releases/latest) [![GitHub license](https://img.shields.io/github/license/Sam-Martin/servicenow-powershell.svg)](LICENSE) ![Test Coverage](https://img.shields.io/badge/coverage-79%25-yellow.svg)
 
 This PowerShell module provides a series of cmdlets for interacting with the [ServiceNow REST API](http://wiki.servicenow.com/index.php?title=REST_API), performed by wrapping `Invoke-RestMethod` for the API calls.
 
@@ -44,7 +44,7 @@ Once you've done this, all the cmdlets will be at your disposal, you can see a f
 Set-ServiceNowAuth -url InstanceName.service-now.com -Credentials (Get-Credential)
 ```
 
-The URL should be the instance name portion of the FQDN for your instance.  For if you browse to `https://yourinstance.service-now.com` the URL required for the module is `yourinstance.service-now.com`.
+The URL should be the instance name portion of the FQDN for your instance.  If you browse to `https://yourinstance.service-now.com` the URL required for the module is `yourinstance.service-now.com`.
 
 ### Example - Retrieving an Incident Containing the Word 'PowerShell'
 
@@ -76,7 +76,7 @@ $IncidentParams = @{Caller = "UserName"
             Description = "This incident was created from Powershell" 
             CustomFields = @{u_service = "MyService"
                             u_incident_type = "Request"}
-            }                            
+            }
 New-ServiceNowIncident @Params
 ```
 

ServiceNow/Public/New-ServiceNowQuery.ps1

@@ -1,15 +1,39 @@
-function New-ServiceNowQuery{
+function New-ServiceNowQuery {
+    <#
+    .SYNOPSIS
+        Build query string for api call
+    .DESCRIPTION
+        Build query string for api call
+    .EXAMPLE
+        New-ServiceNowQuery -MatchExact @{field_name=value}
+
+        Get query string where field name exactly matches the value
+    .EXAMPLE
+        New-ServiceNowQuery -MatchContains @{field_name=value}
+
+        Get query string where field name contains the value
+    .INPUTS
+        None
+    .OUTPUTS
+        String
+    #>
+
+    # This function doesn't change state.  Doesn't justify ShouldProcess functionality
+    [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions','')]
+
+    [CmdletBinding()]
+    [OutputType([System.String])]
 
     param(
         # Machine name of the field to order by
         [parameter(mandatory=$false)]
         [string]$OrderBy='opened_at',
-        
+
         # Direction of ordering (Desc/Asc)
         [parameter(mandatory=$false)]
         [ValidateSet("Desc", "Asc")]
         [string]$OrderDirection='Desc',
-        
+
         # Hashtable containing machine field names and values returned must match exactly (will be combined with AND)
         [parameter(mandatory=$false)]
         [hashtable]$MatchExact,
@@ -18,28 +42,41 @@ function New-ServiceNowQuery{
         [parameter(mandatory=$false)]
         [hashtable]$MatchContains
     )
-    # Start the query off with a order direction
-    $Query = '';
-    if($OrderDirection -eq 'Asc'){
-        $Query += 'ORDERBY'
-    }else{
-        $Query += 'ORDERBYDESC'
-    }
-    $Query +="$OrderBy"
 
-    # Build the exact matches into the query
-    if($MatchExact){
-        foreach($Field in $MatchExact.keys){
-            $Query += "^$Field="+$MatchExact.$Field
+    Try {
+        # Create StringBuilder
+        $Query = New-Object System.Text.StringBuilder
+
+        # Start the query off with a order direction
+        $Order = Switch ($OrderDirection) {
+            'Asc'   {'ORDERBY'}
+            Default {'ORDERBYDESC'}
         }
-    }
+        [void]$Query.Append($Order)
+
+        # Add OrderBy
+        [void]$Query.Append($OrderBy)
 
-    # Add the values which given fields should contain
-    if($MatchContains){
-        foreach($Field in $MatchContains.keys){
-            $Query += "^$($Field)LIKE"+$MatchContains.$Field
+        # Build the exact matches into the query
+        If ($MatchExact) {
+            ForEach ($Field in $MatchExact.keys) {
+                $ExactString = "^{0}={1}" -f $Field.ToString().ToLower(), ($MatchExact.$Field)
+                [void]$Query.Append($ExactString)
+            }
         }
-    }
 
-    return $Query
+        # Add the values which given fields should contain
+        If ($MatchContains) {
+            ForEach ($Field in $MatchContains.keys) {
+                $ContainsString = "^{0}LIKE{1}" -f $Field.ToString().ToLower(), ($MatchContains.$Field)
+                [void]$Query.Append($ContainsString)
+            }
+        }
+
+        # Output StringBuilder to string
+        $Query.ToString()
+    }
+    Catch {
+        Write-Error $PSItem
+    }
 }

ServiceNow/ServiceNow.psd1

@@ -12,7 +12,7 @@
 RootModule = 'ServiceNow.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.2.3'
+ModuleVersion = '1.2.4'
 
 # ID used to uniquely identify this module
 GUID = 'b90d67da-f8d0-4406-ad74-89d169cd0633'
@@ -105,3 +105,5 @@ PrivateData = @{
 
 
 
+
+