Merge pull request #1 from Readify/initial

Skeleton Module

.gitignore

@@ -0,0 +1,2 @@
+
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Telstra Purple Pty. Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

PSScriptAnalyzerSettings.psd1

@@ -0,0 +1,68 @@
+@{
+    IncludeRules = @(
+        'PSAlignAssignmentStatement',
+        'PSAvoid*',
+        'PSDSC*',
+        'PSMisleadingBacktick',
+        'PSMissingModuleManifestField',
+        'PSPlaceCloseBrace',
+        'PSPlaceOpenBrace',
+        'PSPossibleIncorrectComparisonWithNull',
+        'PSPossibleIncorrectUsageOfAssignmentOperator',
+        'PSPossibleIncorrectUsageOfRedirectionOperator',
+        'PSProvideCommentHelp',
+        'PSReservedCmdletChar',
+        'PSReservedParams',
+        'PSShouldProcess',
+        'PSUse*'
+    )
+
+    Rules = @{
+        PSPlaceOpenBrace = @{
+            Enable             = $true
+            OnSameLine         = $true
+            NewLineAfter       = $true
+            IgnoreOneLineBlock = $true
+        }
+
+        PSPlaceCloseBrace = @{
+            Enable             = $true
+            NewLineAfter       = $false
+            IgnoreOneLineBlock = $true
+            NoEmptyLineBefore  = $false
+        }
+
+        PSUseConsistentIndentation = @{
+            Enable              = $true
+            Kind                = 'space'
+            PipelineIndentation = 'IncreaseIndentationForFirstPipeline'
+            IndentationSize     = 4
+        }
+
+        PSUseConsistentWhitespace = @{
+            Enable          = $true
+            CheckInnerBrace = $true
+            CheckOpenBrace  = $false # incorrectly flags all `Should -Throw` Pester assertions
+            CheckOpenParen  = $true
+            CheckOperator   = $false # conflicts with `PSAlignAssignmentStatement`
+            CheckPipe       = $true
+            CheckSeparator  = $true
+            CheckParameter  = $true
+        }
+
+        PSAlignAssignmentStatement = @{
+            Enable         = $true
+            CheckHashtable = $true
+        }
+
+        PSUseCorrectCasing = @{
+            Enable = $true
+        }
+    }
+
+    Severity = @(
+        'Error'
+        'Warning'
+        'Information'
+    )
+}

PwshSparkPost.psd1

@@ -0,0 +1,141 @@
+#
+# Module manifest for module 'PwshSparkPost'
+#
+# Generated by: rob
+#
+# Generated on: 3/4/2020
+#
+
+@{
+
+# Script module or binary module file associated with this manifest.
+RootModule = './PwshSparkPost.psm1'
+
+# Version number of this module.
+ModuleVersion = '0.1.0'
+
+# Supported PSEditions
+CompatiblePSEditions = @(
+    'Core'
+    'Desktop'
+)
+
+# ID used to uniquely identify this module
+GUID = '6ae6071f-86cd-4ece-916b-8aef4861f838'
+
+# Author of this module
+Author = 'Telstra Purple DevSecOps'
+
+# Company or vendor of this module
+CompanyName = 'Telstra Purple Pty Ltd'
+
+# Copyright statement for this module
+Copyright = '(c) 2020 Telstra Purple Pty Ltd. All rights reserved.'
+
+# Description of the functionality provided by this module
+Description = 'SparkPost Api client'
+
+# Minimum version of the PowerShell engine required by this module
+PowerShellVersion = '5.1'
+
+# Name of the PowerShell host required by this module
+# PowerShellHostName = ''
+
+# Minimum version of the PowerShell host required by this module
+# PowerShellHostVersion = ''
+
+# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+# DotNetFrameworkVersion = ''
+
+# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+# ClrVersion = ''
+
+# Processor architecture (None, X86, Amd64) required by this module
+# ProcessorArchitecture = ''
+
+# Modules that must be imported into the global environment prior to importing this module
+# RequiredModules = @()
+
+# Assemblies that must be loaded prior to importing this module
+# RequiredAssemblies = @()
+
+# Script files (.ps1) that are run in the caller's environment prior to importing this module.
+# ScriptsToProcess = @()
+
+# Type files (.ps1xml) to be loaded when importing this module
+# TypesToProcess = @()
+
+# Format files (.ps1xml) to be loaded when importing this module
+# FormatsToProcess = @()
+
+# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+# 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 = @()
+
+# 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 = @()
+
+# Variables to export from this module
+# 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 = @()
+
+# DSC resources to export from this module
+# DscResourcesToExport = @()
+
+# List of all modules packaged with this module
+# ModuleList = @()
+
+# List of all files packaged with this module
+# FileList = @()
+
+# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+PrivateData = @{
+
+    PSData = @{
+
+        # Tags applied to this module. These help with module discovery in online galleries.
+        Tags = @(
+            'PSEdition_Desktop'
+            'PSEdition_Core'
+            'Windows'
+            'Linux'
+            'MacOS'
+        )
+
+        # A URL to the license for this module.
+        # LicenseUri = ''
+
+        # A URL to the main website for this project.
+        ProjectUri = 'https://github.com/Readify/PwshSparkPost'
+
+        # A URL to an icon representing this module.
+        # IconUri = ''
+
+        # ReleaseNotes of this module
+        # ReleaseNotes = ''
+
+        # Prerelease string of this module
+        # Prerelease = ''
+
+        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
+        # RequireLicenseAcceptance = $false
+
+        # External dependent modules of this module
+        # ExternalModuleDependencies = @()
+
+    } # End of PSData hashtable
+
+} # End of PrivateData hashtable
+
+# HelpInfo URI of this module
+# HelpInfoURI = ''
+
+# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+DefaultCommandPrefix = 'SparkPost'
+
+}
+

PwshSparkPost.psm1

@@ -0,0 +1,14 @@
+
+Set-StrictMode -Version Latest
+
+Get-ChildItem -Path "$PSScriptRoot\functions" -Filter '*.ps1' -Recurse | ForEach-Object {
+    . $_.FullName
+    Export-ModuleMember -Function $_.BaseName
+}
+
+Get-ChildItem -Path "$PSScriptRoot\internal" -Filter '*.ps1' -Recurse | ForEach-Object {
+    . $_.FullName
+}
+
+$Script:NotConnectedMessage = 'No connection supplied or stored. Please either call `Connect-SparkPost` or call `Get-SparkPostConnection` and pass the result to all additional calls.'
+$Script:InvalidConnection = 'Provided connection is invalid.'