-
Notifications
You must be signed in to change notification settings - Fork 585
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.
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
Add HipChat notification helper #523
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
/// Contains a task to send notification messages to a [HipChat](https://www.hipchat.com/) room | ||
module Fake.HipChatNotificationHelper | ||
|
||
open System | ||
open System.Web | ||
open Fake | ||
|
||
/// The HipChat notification paramater type | ||
type HipChatNotificationParams = { | ||
/// (Required) Auth token from HipChat | ||
AuthToken: string | ||
/// (Required) ID or name of the room to send the notification to | ||
RoomId: string | ||
/// (Required) Name the message will appear to be sent from | ||
From: string | ||
/// (Required) The message body | ||
Message: string | ||
/// The message format, which can either be text or html. Default value: text | ||
MessageFormat: string | ||
/// Whether or not this message should trigger a notification for people in the room. Default value: false | ||
Notify: bool | ||
/// The background color for the message, which can be yellow, red, green, purple, gray, or random. Default value: yellow | ||
Color: string | ||
} | ||
|
||
/// The default HipChat notification parameters | ||
let HipChatNotificationDefaults = { | ||
AuthToken = "" | ||
RoomId = "" | ||
From = "" | ||
Message = "" | ||
MessageFormat = "text" | ||
Notify = false | ||
Color = "yellow" | ||
} | ||
|
||
/// [omit] | ||
let validateParams param = | ||
if param.AuthToken = "" then failwith "You must provide your auth token" | ||
if param.RoomId = "" then failwith "You must specify which room to notify" | ||
if param.From = "" then failwith "You must specify the name to send the message from" | ||
if param.Message = "" then failwith "You must provide a message to send" | ||
|
||
param | ||
|
||
/// Sends a notification to a HipChat room | ||
/// ## Parameters | ||
/// - `setParams` - Function used to override the default notification parameters | ||
let HipChatNotification (setParams: HipChatNotificationParams -> HipChatNotificationParams) = | ||
let sendNotification param = | ||
["room_id", param.RoomId | ||
"from", param.From | ||
"message", param.Message | ||
"message_format", param.MessageFormat | ||
"notify", Convert.ToInt32(param.Notify).ToString() | ||
"color", param.Color | ||
"format", "json"] | ||
|> List.map(fun (key, value) -> key + "=" + HttpUtility.UrlEncode(value)) | ||
|> String.concat "&" | ||
|> fun curlData -> String.Format("-s -d {0} https://api.hipchat.com/v1/rooms/message?auth_token={1}&format=json", curlData, param.AuthToken) | ||
|> fun curlArgs -> Shell.Exec("curl", curlArgs) | ||
|
||
HipChatNotificationDefaults | ||
|> setParams | ||
|> validateParams | ||
|> sendNotification |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is the only reason to reference System.Web, could you use
Uri.EscapeDataString()
instead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point, that should work too. Are there plans to update FAKE to .NET 4.5? If so,
WebUtility.UrlEncode()
would work as well.