v2.0.0.0

Version 2.0.0.0 (2017-08-13)

Module Manifest

• All RequiredAssemblies have been removed

Root Module

• Added $PSDefaultParameterValues for Invoke-WebRequest to set -SkipHeaderValidation if available (for backwards compatibility with 5.1)
• Added $PsrawSettings module scope hashtable variable to house settings such as the session default OAuth token.

Public Functions

Connect-Reddit

• Added to Streamline and simplify the initial OAUth process.

Export-RedditOAuthToken

• All parameters are no longer mandatory to accommodate exporting the default token to its default path

Get-RedditDefaultOAuthToken

• Added to retrieve the Default token for the session

Import-RedditOAuthToken

• Now returns nothing by default. Use -PassThru to return the imported token
• Sets the imported token as the session default Token.

Invoke-RedditRequest

• Now has irr alias to mimic iwr and irm aliases.
• Invoke-WebRequest error handling logic reworked to support 5.1 and 6.0
• Access token is no longer mandatory and uses the session default AccessToken if one is not supplied

New-RedditApplication

• Default Parameter Set changed to Script
• Name parameter is no longer Mandatory to simplify connecting
• Scope parameter has been deprecated and is no longer Mandatory
• UserAgent no longer mandatory. default is now PowerShell:PSRAW:2.0 (by /u/markekraus)

Request-RedditOAuthToken

• Now returns nothing by default. Use -PassThru to return the token
• Sets the retrieved token as the session default token.
• Code and Implicit parameter sets have been removed.
• Code and Implicit parameters have been removed
• Code and Implicit grants flows have been removed
• State parameter has been removed (was only required for Implicit grants)

Set-RedditDefaultOAuthToken

• Added to set the session default token

Update-RedditOAuthToken

• -AccessToken is no longer mandatory and the default is the session default token
• Code and Implicit grants flows have been removed
• -SetDefault switch added to set the updated token as the session default token.

Private Functions

Get-HttpResponseContentType

• Added Get-HttpResponseContentType to get API response Content-Type as 6.0 and 5.1 currently house this in different locations.

Request-RedditOAuthCode

• Removed Request-RedditOAuthCode as it is no needed without Code grant flow

Request-RedditOAuthTokenClient

• Now returns a RedditOAuthResponse

Request-RedditOAuthTokenCode

• Removed Request-RedditOAuthTokenCode as it is not needed without Code grant flow

Request-RedditOAuthTokenImplicit

• Removed Request-RedditOAuthTokenImplicit as it is not needed without Implicit grant flow

Request-RedditOAuthTokenInstalled

• Now returns a RedditOAuthResponse

Request-RedditOAuthTokenPassword

• Now returns a RedditOAuthResponse

Request-RedditOAuthTokenRefresh

• Removed Request-RedditOAuthTokenRefresh as it is no longer needed without Code grant flow

Show-RedditOAuthWindow

• Removed Show-RedditOAuthWindow as it is not compatible with Core (this is why Code and Implicit grant flows are no longer available)

Classes

RedditApplication

• Scope is now hidden as it serves no purpose without Code grant flows.
• Removed GetAuthorizationUrl() and _GetAuthorizationUrl() as they depended on System.Web (not available in Core) and are not needed without the Code or Implicit grant flows.

ReditOAuthCode

• This class has been deleted as it is not needed without the Code grant flow.

RedditOAuthResponse

• Created RedditOAuthResponse class to abstract the OAuth response from Reddit.

RedditOAuthToken

• Removed RefreshCredential (not needed without Code grant flow)
• Constructors now take a RedditOAuthResponse instead of a PSobject and the code adjusted to use its properties
• GetRefreshToken() Removed (not needed without Code grant flow)
• Refresh() now takes a RedditOAuthResponse
• UpdateRateLimit() adjusted to support both 5.1 and 6.0 style headers dictionaries.
• Default constructor now sets the GUID to [GUID]:Empty

RedditApiResponse

• Response and ContentObject are now appropriately typed
• Added ContentTypeproperty to hold the Content-Type information

RedditDate

• Added RedditDate class to handle unix-to-date and date-to-unix translations for dates returned from the API.

RedditThing

• Added RedditThing class to work with "Reddit Things" returned from the Reddit API

RedditModReport

• Added RedditModReport to house moderator reports

RedditUserReport

• Added RedditUserReport to house user reports

RedditComment

• Added RedditComment to house comments.

Enums

RedditOAuthGrantType

• Removed Authorization_Code, Refresh_Token, and Implicit which are not needed without Code and Implicit grant flows

RedditThingKind

• Added RedditThingKind to Define "Reddit Thing" "Kind" (their terms, not mine)

RedditThingPrefix

• Added RedditThingPrefix to define valid prefixes for "Reddit Things"

v1.1.0.7

Version 1.1.0.7 (2017-05-27)

Module Manifest

• Cleaned up PSMSGraph Reference
• Added PSRAW Icon

v1.1.0.6

Version 1.1.0.6 (2017-05-26)

What's new?

Everything! This is the initial release of PSRAW so everything is a new feature! Check out the project at https://github.com/markekraus/PSRAW/ and the documentation at https://psraw.readthedocs.io/

This is a "Core Functionality" release. It provides all the components needed to build the rest of the functionality this module will provide. It does not include any of the wrapper functionality, but it is capable of making authenticated API calls in a manner similar to Invoke-WebRequest

Public Functions

API

Invoke-RedditRequest

• Provides authenticated access to the Reddit API in a Invoke-WebRequest style.

Application

Export-RedditApplication

• Provides the ability to export RedditApplication objects so they can be imported later by Import-RedditApplication

Import-RedditApplication

• Provides the ability import RedditApplication objects previously exported by Export-RedditApplication

New-RedditApplication

• Creates new RedditApplication objects that can be used to request OAuth access to the API.

OAuth

Export-RedditOAuthToken

• Provides the ability to export RedditOAuthToken objects so they can be imported later by Import-RedditPAuthToken

Get-RedditOAuthScope

• Retrieves all valid OAuth Scopes from reddit as RedditOAuthScope objects.

Import-RedditOAuthToken

• Provides the ability import RedditOAuthToken objects previously exported by Export-RedditOAuthToken

Request-RedditOAuthToken

• Provides the ability to request OAuth Authorization and Access Tokens for all Grant Flows supported by reddit. Creates new RedditOAuthToken objects.

Update-RedditOAuthToken

• Provides lifecycle management of OAuth Access Tokens stored in RedditOAuthToken objects and perms refresh or re-grant operations when they expire.

Classes

PSRAW Classes automatically become available in the calling scope when the module is Imported!

Api

RedditApiResponse

• Used for API responses from Invoke-RedditRequest

Application

RedditApplication

• Models an Application as it is registered on Reddit and used to request RedditOAuthToken objects

OAuth

RedditOAuthCode

• Returned by the Request-RedditOAuthCode private function used in Code grant flows for OAuth. Provides a secure means of temporarily storing the Authentication Code.

RedditOAuthScope

• Models the Reddit OAuth Scopes available for the Reddit API.

RedditOAuthToken

• Houses the authorized RedditApplication, the OAuth Access Token and Refresh Token (if present) and used to authenticated to the Reddit API.

Enums

PSRAW Enums automatically become available in the calling scope when the module is Imported!

Application

RedditApplicationType

• provides the available types for RedditApplication objects

OAuth

RedditOAuthDuration

• provides the available OAuth Duration types.

RedditOAuthGrantType

• Provides the available OAuth Grant Flow Types.

RedditOAuthResponseType

• Provides the available OAuth Response Types to request.

Help

Help topics are available for all public functions, classes and Enums! Examples:

Get-Help Invoke-RedditRequest

Get-Help about_RedditOAuthToken

Get-Help about_RedditApplicationType

All functions (public and private) and all classes and enums are also documented online at https://psraw.readthedocs.io/

Private Functions

API

Wait-RedditApiRateLimit provides Rate Limit cooldown.

OAuth

The following functions have been added to deal with OAuth Grant flow in the function name

• Request-RedditOAuthTokenClient
• Request-RedditOAuthTokenCode
• Request-RedditOAuthTokenImplicit
• Request-RedditOAuthTokenInstalled
• Request-RedditOAuthTokenPassword
• Request-RedditOAuthTokenRefresh

Get-AuthorizationHeader provides the rfc2617 Authorization header required by Reddit for OAuth Access Token requests.

Request-RedditOAuthCode is used to request Authorization codes in `Code grant flows.

Show-RedditOAuthWindows provides a WinForms GUI browser for the Grant Flows that require the user to log i to the site and authorize the application.

v1.1.0.5

Version 1.1.0.5 (2017-05-26)

What's new?

Everything! This is the initial release of PSRAW so everything is a new feature! Check out the project at https://github.com/markekraus/PSRAW/ and the documentation at https://psraw.readthedocs.io/

This is a "Core Functionality" release. It provides all the components needed to build the rest of the functionality this module will provide. It does not include any of the wrapper functionality, but it is capable of making authenticated API calls in a manner similar to Invoke-WebRequest

Public Functions

API

Invoke-RedditRequest

• Provides authenticated access to the Reddit API in a Invoke-WebRequest style.

Application

Export-RedditApplication

• Provides the ability to export RedditApplication objects so they can be imported later by Import-RedditApplication

Import-RedditApplication

• Provides the ability import RedditApplication objects previously exported by Export-RedditApplication

New-RedditApplication

• Creates new RedditApplication objects that can be used to request OAuth access to the API.

OAuth

Export-RedditOAuthToken

• Provides the ability to export RedditOAuthToken objects so they can be imported later by Import-RedditPAuthToken

Get-RedditOAuthScope

• Retrieves all valid OAuth Scopes from reddit as RedditOAuthScope objects.

Import-RedditOAuthToken

• Provides the ability import RedditOAuthToken objects previously exported by Export-RedditOAuthToken

Request-RedditOAuthToken

• Provides the ability to request OAuth Authorization and Access Tokens for all Grant Flows supported by reddit. Creates new RedditOAuthToken objects.

Update-RedditOAuthToken

• Provides lifecycle management of OAuth Access Tokens stored in RedditOAuthToken objects and perms refresh or re-grant operations when they expire.

Classes

PSRAW Classes automatically become available in the calling scope when the module is Imported!

Api

RedditApiResponse

• Used for API responses from Invoke-RedditRequest

Application

RedditApplication

• Models an Application as it is registered on Reddit and used to request RedditOAuthToken objects

OAuth

RedditOAuthCode

• Returned by the Request-RedditOAuthCode private function used in Code grant flows for OAuth. Provides a secure means of temporarily storing the Authentication Code.

RedditOAuthScope

• Models the Reddit OAuth Scopes available for the Reddit API.

RedditOAuthToken

• Houses the authorized RedditApplication, the OAuth Access Token and Refresh Token (if present) and used to authenticated to the Reddit API.

Enums

PSRAW Enums automatically become available in the calling scope when the module is Imported!

Application

RedditApplicationType

• provides the available types for RedditApplication objects

OAuth

RedditOAuthDuration

• provides the available OAuth Duration types.

RedditOAuthGrantType

• Provides the available OAuth Grant Flow Types.

RedditOAuthResponseType

• Provides the available OAuth Response Types to request.

Help

Help topics are available for all public functions, classes and Enums! Examples:

Get-Help Invoke-RedditRequest

Get-Help about_RedditOAuthToken

Get-Help about_RedditApplicationType

All functions (public and private) and all classes and enums are also documented online at https://psraw.readthedocs.io/

Private Functions

API

Wait-RedditApiRateLimit provides Rate Limit cooldown.

OAuth

The following functions have been added to deal with OAuth Grant flow in the function name

• Request-RedditOAuthTokenClient
• Request-RedditOAuthTokenCode
• Request-RedditOAuthTokenImplicit
• Request-RedditOAuthTokenInstalled
• Request-RedditOAuthTokenPassword
• Request-RedditOAuthTokenRefresh

Get-AuthorizationHeader provides the rfc2617 Authorization header required by Reddit for OAuth Access Token requests.

Request-RedditOAuthCode is used to request Authorization codes in `Code grant flows.

Show-RedditOAuthWindows provides a WinForms GUI browser for the Grant Flows that require the user to log i to the site and authorize the application.