Merge pull request #1 from snazy2000/develop

Merge Changes in to Master

Author: snazy2000

.vscode/launch.json

@@ -1,13 +1,6 @@
 {
     "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "PowerShell",
-            "request": "launch",
-            "name": "PowerShell Interactive Session",
-            "cwd": "${workspaceRoot}"
-        },
-        {
+    "configurations": [{
             "type": "PowerShell",
             "request": "launch",
             "name": "PowerShell Pester Tests",
@@ -22,6 +15,19 @@
             "script": "${file}",
             "args": [],
             "cwd": "${file}"
+        },
+        {
+            "type": "PowerShell",
+            "request": "attach",
+            "name": "PowerShell Attach to Host Process",
+            "processId": "${command.PickPSHostProcess}",
+            "runspaceId": 1
+        },
+        {
+            "type": "PowerShell",
+            "request": "launch",
+            "name": "PowerShell Interactive Session",
+            "cwd": "${workspaceRoot}"
         }
     ]
-}
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.encoding": "utf8",
+    "files.eol": "\r\n",
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true,
+    "editor.tabSize": 4,
+    "[markdown]": {
+        "editor.wordwrap": "on",
+        "editor.renderWhitespace": "all",
+        "editor.acceptSuggestionOnEnter": false,
+        "editor.rulers": [80],
+        "editor.trimAutoWhitespace": false
+    }
+}

.vscode/tasks.json

@@ -0,0 +1,56 @@
+// Available variables which can be used inside of strings.
+// ${workspaceRoot}: the root folder of the team
+// ${file}: the current opened file
+// ${relativeFile}: the current opened file relative to workspaceRoot
+// ${fileBasename}: the current opened file's basename
+// ${fileDirname}: the current opened file's dirname
+// ${fileExtname}: the current opened file's extension
+// ${cwd}: the current working directory of the spawned process
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    // Start PowerShell
+    "windows": {
+        "command": "${env:windir}\\sysnative\\windowspowershell\\v1.0\\PowerShell.exe",
+        "args": [
+            "-NoProfile",
+            "-ExecutionPolicy",
+            "Bypass"
+        ]
+    },
+    "linux": {
+        "command": "/usr/bin/powershell",
+        "args": [
+            "-NoProfile"
+        ]
+    },
+    "osx": {
+        "command": "/usr/local/bin/powershell",
+        "args": [
+            "-NoProfile"
+        ]
+    },
+    // Show the output window always
+    "showOutput": "always",
+    // Associate with test task runner
+    "tasks": [{
+            "taskName": "Build Help",
+            "suppressTaskName": true,
+            "args": [
+                "Write-Host 'Invoking platyPS'; New-ExternalHelp -Path .\\docs\\en-US -OutputPath .\\ConfluencePS\\en-US -Force;",
+                "Invoke-Command { Write-Host 'Completed Build task in task runner.' }"
+            ]
+        },
+        {
+            "taskName": "Test",
+            "suppressTaskName": true,
+            "isTestCommand": true,
+            "args": [
+                "Write-Host 'Invoking Pester'; Invoke-Pester -PesterOption @{IncludeVSCodeMarker=$true};",
+                "Invoke-Command { Write-Host 'Completed Test task in task runner.' }"
+            ],
+            "problemMatcher": "$pester"
+        }
+    ]
+}

CHANGELOG.md

@@ -1 +1,8 @@
-[1.0]
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0] - 2017-11-18

README.md

@@ -1 +1,30 @@
-[![Build status](https://ci.appveyor.com/api/projects/status/dvuw4ggx543nx3h7?svg=true)](https://ci.appveyor.com/project/snazy2000/snipeitps)
+[![GitHub release](https://img.shields.io/github/release/snazy2000/SnipeitPS.svg)](https://github.com/snazy2000/snipeitps/releases/latest) [![Build status](https://ci.appveyor.com/api/projects/status/dvuw4ggx543nx3h7/branch/master?svg=true)](https://ci.appveyor.com/project/snazy2000/snipeitps/branch/master) [![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/snipeitps.svg)](https://www.powershellgallery.com/packages/snipeitps) ![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+---
+
+## Instructions
+
+### Installation
+
+Install SnipeitPS from the PowerShell Gallery `Install-Module` requires PowerShellGet (included in PS v5, or download for v3/v4 via the gallery link)
+
+```powershell
+# One time only install: (requires an admin PowerShell window)
+Install-Module SnipeitPS
+
+# Check for updates occasionally:
+Update-Module SnipeitPS
+
+# To use each session:
+Import-Module SnipeitPS
+Set-Info -URL 'https://asset.example.com' -apiKey 'tokenKey'
+```
+
+### Usage
+
+```powershell
+# Review the help at any time!
+Get-Help about_SnipeitPS
+Get-Command -Module SnipeitPS
+Get-Help Get-Asset -Full   # or any other command
+```

SnipeItPS.build.ps1

@@ -217,6 +217,7 @@ task PushRelease GitStatus, GetVersion, {
 }
 # endregion
 
+
 #region Cleaning tasks
 task Clean RemoveGeneratedFiles
 
@@ -236,4 +237,4 @@ task RemoveMarkdownFiles {
 }
 # endregion
 
-task . ShowDebug, Clean, Test, Build, Deploy
+task . ShowDebug, Clean, Test, Build, Deploy

SnipeitPS/Private/Invoke-Method.psm1 renamed to SnipeitPS/Private/Invoke-SnipeitMethod.ps1

@@ -1,4 +1,4 @@
-function Invoke-Method {
+function Invoke-SnipeitMethod {
     <#
     .SYNOPSIS
     Extracted invokation of the REST method to own function.
@@ -42,7 +42,7 @@
     }
 
     Process {
-        if ($GetParameters -and ($URi -notlike "*\?*")) 
+        if ($GetParameters -and ($URi -notlike "*\?*"))
         {
             Write-Debug "Using `$GetParameters: $($GetParameters | Out-String)"
             [string]$URI += (ConvertTo-GetParameter $GetParameters)
@@ -86,7 +86,7 @@
 
                 # API returned a Content: lets work wit it
                 $response = ConvertFrom-Json -InputObject $webResponse.Content
-                
+
                 if ($response.status -eq "error") {
                     Write-Verbose "[$($MyInvocation.MyCommand.Name)] An error response was received from; resolving"
                     # This could be handled nicely in an function such as:
@@ -95,14 +95,14 @@
                 }
                 else {
                     $result = $response
-                    if (($response) -and ($response | Get-Member -Name payload)) 
+                    if (($response) -and ($response | Get-Member -Name payload))
                     {
                         $result = $response.payload
                     }
                     elseif (($response) -and ($response | Get-Member -Name rows)) {
                         $result = $response.rows
                     }
-                        
+
                     $result
                 }
             }
@@ -111,7 +111,7 @@
                 # This could be wanted behavior of the API
                 Write-Verbose "[$($MyInvocation.MyCommand.Name)] No content was returned from."
             }
-            
+
         }
         else {
             Write-Verbose "[$($MyInvocation.MyCommand.Name)] No Web result object was returned from. This is unusual!"
@@ -121,4 +121,4 @@
     END {
         Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function ended"
     }
-}
+}