PowerShell 7.0 SDK for CloudEvents

Go to file

Michael Gasch 112e84313d Merge pull request #49 from dmilov/topic/bump-module-version-for-release chore: Bump module version for new release		2021-09-08 20:38:53 +02:00
.chglog	chore: Include commit details in CHANGELOG	2021-06-09 15:23:23 +02:00
.github	chore: Trigger release on tag push	2021-09-08 17:22:52 +02:00
src/CloudEventsPowerShell	chore: Bump module version for new release	2021-09-08 20:08:53 +03:00
test	fix: Incorrect parsing of Binary Content Mode cloud events	2021-08-30 10:45:53 +03:00
.gitignore	Initial commit	2021-04-07 09:40:42 -07:00
CHANGELOG.md	Update CHANGELOG for v0.3.1	2021-08-30 09:48:51 +00:00
CONTRIBUTING.md	Create CONTRIBUTING.md (#15 )	2021-04-19 08:55:35 +03:00
LICENSE	Initial commit	2021-04-07 09:40:42 -07:00
README.md	Update README with the new version output	2021-06-21 16:29:32 +03:00
RELEASE.md	chore: Add RELEASE instructions	2021-06-21 20:30:46 +02:00
build.ps1	Implement publish script	2021-05-28 10:43:27 +03:00
publish.ps1	Implement publish script	2021-05-28 10:43:27 +03:00

README.md

PowerShell 7.0 SDK for CloudEvents based on .NET SDK for CloudEvents

Status

Supported CloudEvents versions:

v1.0

Supported Protocols:

HTTP

`CloudEvents.Sdk` Module

The module contains functions to

Create CloudEvent objects
Add data to a CloudEvent object
Read data from a CloudEvent object
Convert a CloudEvent object to an HTTP Message
Convert an HTTP Message to a CloudEvent object

Install `CloudEvents.Sdk` Module

Prerequisites

PowerShell 7.0

Install-Module CloudEvents.Sdk
Import-Module CloudEvents.Sdk
Get-Command -Module CloudEvents.Sdk

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Function        ConvertFrom-HttpMessage                            0.3.0      CloudEvents.Sdk
Function        ConvertTo-HttpMessage                              0.3.0      CloudEvents.Sdk
Function        New-CloudEvent                                     0.3.0      CloudEvents.Sdk
Function        Read-CloudEventData                                0.3.0      CloudEvents.Sdk
Function        Read-CloudEventJsonData                            0.3.0      CloudEvents.Sdk
Function        Read-CloudEventXmlData                             0.3.0      CloudEvents.Sdk
Function        Set-CloudEventData                                 0.3.0      CloudEvents.Sdk
Function        Set-CloudEventJsonData                             0.3.0      CloudEvents.Sdk
Function        Set-CloudEventXmlData                              0.3.0      CloudEvents.Sdk

Using `CloudEvents.Sdk` Module

1. Event Producer

Create a CloudEvent object

$cloudEvent = New-CloudEvent -Type 'com.example.object.deleted.v2' -Source 'mailto:cncf-wg-serverless@lists.cncf.io' -Id (New-Guid).Guid -Time (Get-Date)

Set JSON Data to a CloudEvent object

$cloudEvent | Set-CloudEventJsonData -Data @{
    'Foo' = 'Hello'
    'Bar' = 'World'
}


DataContentType : application/json
Data            : {
                    "Bar": "World",
                    "Foo": "Hello"
                  }
Id              : ac9b12d9-ae45-4654-a4d7-42bbf0d9816d
DataSchema      :
Source          : mailto:cncf-wg-serverless@lists.cncf.io
SpecVersion     : V1_0
Subject         :
Time            : 4/26/2021 9:00:45 AM
Type            : com.example.object.deleted.v2

Set XML Data to a CloudEvent object

$cloudEvent | Set-CloudEventXmlData -Data @{
    'xml' = @{
        'Foo' = 'Hello'
        'Bar' = 'World'
    }
} `
-AttributesKeysInElementAttributes $true


DataContentType : application/xml
Data            : <xml><Bar>World</Bar><Foo>Hello</Foo></xml>
Id              : ac9b12d9-ae45-4654-a4d7-42bbf0d9816d
DataSchema      :
Source          : mailto:cncf-wg-serverless@lists.cncf.io
SpecVersion     : V1_0
Subject         :
Time            : 4/26/2021 9:00:45 AM
Type            : com.example.object.deleted.v2

Set Custom Format Data to a CloudEvent object

$cloudEvent | Set-CloudEventData -DataContentType 'application/text' -Data 'Hello World!'

DataContentType : application/text
Data            : Hello World!
Id              : b1b748cd-e98d-4f5f-80ea-76dea71a53a5
DataSchema      :
Source          : mailto:cncf-wg-serverless@lists.cncf.io
SpecVersion     : V1_0
Subject         :
Time            : 4/27/2021 7:00:44 PM
Type            : com.example.object.deleted.v2

Convert a CloudEvent object to an HTTP message in Binary or Structured content mode

# Format structured cloud event HTTP message
$cloudEventStructuredHttpMessage = $cloudEvent | ConvertTo-HttpMessage -ContentMode Structured

Send CloudEvent object to HTTP server

Invoke-WebRequest -Method POST -Uri 'http://my.cloudevents.server/' -Headers $cloudEventStructuredHttpMessage.Headers -Body $cloudEventStructuredHttpMessage.Body

2. Event Consumer

Convert an HTTP message to a CloudEvent object

$cloudEvent = ConvertFrom-HttpMessage -Headers <headers> -Body <body>

Read CloudEvent JSON Data as a PowerShell Hashtable

Read-CloudEventJsonData -CloudEvent $cloudEvent


Name                           Value
----                           -----
Foo                            Hello
Bar                            World

Read CloudEvent XML Data as a PowerShell Hashtable

Read-CloudEventXmlData -CloudEvent $cloudEvent -ConvertMode SkipAttributes

Name                           Value
----                           -----
xml                            {Bar, Foo}

The ConvertMode parameter specifies how the xml should be converted to a PowerShell Hashtable. SkipAttributes mode skips reading the xml attributes. There are three different modes of conversion. For more details check the help of the Read-CloudEventXmlData cmdlet.

Read CloudEvent Custom Format Data as a byte[]

Read-CloudEventData -CloudEvent $cloudEvent

72
101
108
108
111
32
87
111
114
108
100
33