Skip to content

Add support for comment APIs #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Howard Wolosky (HowardWolosky) merged 22 commits into from
Nov 30, 2018
Merged

Add support for comment APIs #53

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
219104c
Initial work
joseartrivera Nov 19, 2018
45049f3
add test
joseartrivera Nov 20, 2018
10e6b1f
Finish tests and clean up docs
joseartrivera Nov 26, 2018
8e11d53
Adding to usage.md
joseartrivera Nov 26, 2018
49f7863
Few tweaks
joseartrivera Nov 26, 2018
cf4f95c
Address PR comments
joseartrivera Nov 27, 2018
9dd1052
Merge remote-tracking branch 'upstream/master' into CommentSupport
joseartrivera Nov 27, 2018
977e9b0
Style fixes
joseartrivera Nov 27, 2018
f3949d9
Make get comments one method
joseartrivera Nov 29, 2018
b5c74f1
Do not supply params
joseartrivera Nov 29, 2018
f76cbf9
PR comments
joseartrivera Nov 29, 2018
fcf6633
Update tests and psd1
joseartrivera Nov 29, 2018
7be8552
Support media types
joseartrivera Nov 29, 2018
34b7fd1
End on an empty line
joseartrivera Nov 29, 2018
13388e0
Set default value instead of empty string validation
joseartrivera Nov 29, 2018
348f12b
PR feedback
joseartrivera Nov 30, 2018
35978f1
Remove media type version
joseartrivera Nov 30, 2018
2014734
Move varibles and simplify some code
joseartrivera Nov 30, 2018
b53b270
lower case mediaTypeVersion
joseartrivera Nov 30, 2018
6cfa2d4
Remove trailing whitespace
joseartrivera Nov 30, 2018
0558a74
Merge with master
joseartrivera Nov 30, 2018
1133da3
Commit unsaved usage file
joseartrivera Nov 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 9 additions & 41 deletions GitHubComments.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

$script:MediaTypeVersion = 'v3'
Comment thread
joseartrivera marked this conversation as resolved.
Outdated

function Get-GitHubComment
{
<#
Expand Down Expand Up @@ -45,11 +47,6 @@ function Get-GitHubComment
html - Return HTML rendered from the body's markdown. Response will include body_html.
full - Return raw, text and HTML representations. Response will include body, body_text, and body_html.

.PARAMETER MediaTypeVersion
The version of the response to return. The default version of the API may change in the future.
If you're building an application and care about the stability of the API, be sure to request
a specific version. More info at https://developer.github.com/v3/media/.

.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
Expand Down Expand Up @@ -112,8 +109,6 @@ function Get-GitHubComment
[ValidateSet('raw', 'text', 'html', 'full')]
[string] $MediaType ='raw',

[string] $MediaTypeVersion = 'VERSION',

[string] $AccessToken,

[switch] $NoStatus
Expand Down Expand Up @@ -180,7 +175,7 @@ function Get-GitHubComment
'UriFragment' = $uriFragment
'Description' = $description
'AccessToken' = $AccessToken
'AcceptHeader' = (Get-CommentAcceptHeader -MediaType $MediaType -MediaTypeVersion $MediaTypeVersion)
'AcceptHeader' = (Get-CommentAcceptHeader -MediaType $MediaType)
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
Expand Down Expand Up @@ -224,11 +219,6 @@ function New-GitHubComment
html - Return HTML rendered from the body's markdown. Response will include body_html.
full - Return raw, text and HTML representations. Response will include body, body_text, and body_html.

.PARAMETER MediaTypeVersion
The version of the response to return. The default version of the API may change in the future.
If you're building an application and care about the stability of the API, be sure to request
a specific version. More info at https://developer.github.com/v3/media/.

.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
Expand Down Expand Up @@ -269,8 +259,6 @@ function New-GitHubComment
[ValidateSet('raw', 'text', 'html', 'full')]
[string] $MediaType ='raw',

[string] $MediaTypeVersion = 'VERSION',

[string] $AccessToken,

[switch] $NoStatus
Expand Down Expand Up @@ -298,7 +286,7 @@ function New-GitHubComment
'Method' = 'Post'
'Description' = "Creating comment under issue $Issue for $RepositoryName"
'AccessToken' = $AccessToken
'AcceptHeader' = (Get-CommentAcceptHeader -MediaType $MediaType -MediaTypeVersion $MediaTypeVersion)
'AcceptHeader' = (Get-CommentAcceptHeader -MediaType $MediaType)
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
Expand Down Expand Up @@ -342,11 +330,6 @@ function Set-GitHubComment
html - Return HTML rendered from the body's markdown. Response will include body_html.
full - Return raw, text and HTML representations. Response will include body, body_text, and body_html.

.PARAMETER MediaTypeVersion
The version of the response to return. The default version of the API may change in the future.
If you're building an application and care about the stability of the API, be sure to request
a specific version. More info at https://developer.github.com/v3/media/.

.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
Expand Down Expand Up @@ -387,8 +370,6 @@ function Set-GitHubComment
[ValidateSet('raw', 'text', 'html', 'full')]
[string] $MediaType ='raw',

[string] $MediaTypeVersion = 'VERSION',

[string] $AccessToken,

[switch] $NoStatus
Expand Down Expand Up @@ -416,7 +397,7 @@ function Set-GitHubComment
'Method' = 'Patch'
'Description' = "Update comment $CommentID for $RepositoryName"
'AccessToken' = $AccessToken
'AcceptHeader' = (Get-CommentAcceptHeader -MediaType $MediaType -MediaTypeVersion $MediaTypeVersion)
'AcceptHeader' = (Get-CommentAcceptHeader -MediaType $MediaType)
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
'NoStatus' = (Resolve-ParameterWithDefaultConfigurationValue -Name NoStatus -ConfigValueName DefaultNoStatus)
Expand Down Expand Up @@ -518,7 +499,7 @@ function Get-CommentAcceptHeader
{
<#
.DESCRIPTION
Returns a formatted AcceptHeader based on the requested MediaType and MediaTypeVersion
Returns a formatted AcceptHeader based on the requested MediaType

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

Expand All @@ -530,31 +511,18 @@ function Get-CommentAcceptHeader
html - Return HTML rendered from the body's markdown. Response will include body_html.
full - Return raw, text and HTML representations. Response will include body, body_text, and body_html.

.PARAMETER MediaTypeVersion
The version of the response to return. The default version of the API may change in the future.
If you're building an application and care about the stability of the API, be sure to request
a specific version. More info at https://developer.github.com/v3/media/.

.EXAMPLE
Get-CommentAcceptHeader -MediaType raw MediaTypeVersion v3
Get-CommentAcceptHeader -MediaType raw

Returns a formatted AcceptHeader for v3 of the response object
#>
[CmdletBinding()]
param(
[ValidateSet('raw', 'text', 'html', 'full')]
[string] $MediaType ='raw',

[string] $MediaTypeVersion = 'VERSION'
[string] $MediaType ='raw'
)

$acceptHeaders = @()

<# If the user has not specified a specific version, add the preview acceptHeader #>
if ('VERSION' -eq $MediaTypeVersion)
{
$acceptHeaders += 'application/vnd.github.squirrel-girl-preview'
}
$acceptHeaders = @('application/vnd.github.squirrel-girl-preview')

if ('raw' -eq $MediaType)
Comment thread
joseartrivera marked this conversation as resolved.
Outdated
{
Expand Down