Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update "t" help comments

  • Loading branch information...
commit f1ae7b7b0ddab95bae0c915ea37f5c666a726104 1 parent 372727e
@technicalpickles technicalpickles authored
View
20 src/scripts/talkative.coffee
@@ -1,9 +1,19 @@
-# Respond to custom answers
-# hubot say something about <topic> - will say something he knows about the subject
-# hubot when asked <regexp_of_question> answer <response> - teach your bot to answer to <regexp_of_question> with <response>
-# hubot forget answers - remove every teached answer from bot brain
+# Description:
+# Respond to custom answers
#
-# requires redis-brain
+# Dependencies:
+# redis-brain.coffee
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot say something about <topic> - will say something he knows about the subject
+# hubot when asked <regexp_of_question> answer <response> - teach your bot to answer to <regexp_of_question> with <response>
+# hubot forget answers - remove every teached answer from bot brain
+#
+# Author:
+# NNA
module.exports = (robot) ->
View
18 src/scripts/tasks.coffee
@@ -1,9 +1,19 @@
-# Allows tasks (TODOs) to be added to Hubot
+# Description:
+# Allows tasks (TODOs) to be added to Hubot
#
-# hubot task add <task> - Add a task
-# hubot task list tasks - List the tasks
-# hubot task delete <task number> - Delete a task
+# Dependencies:
+# None
#
+# Configuration:
+# None
+#
+# Commands:
+# hubot task add <task> - Add a task
+# hubot task list tasks - List the tasks
+# hubot task delete <task number> - Delete a task
+#
+# Author:
+# Crofty
class Tasks
constructor: (@robot) ->
View
27 src/scripts/team-city-listener.coffee
@@ -1,8 +1,25 @@
-# This script used in conjunction with tcWebHooks: http://tcplugins.sourceforge.net/info/tcWebHooks will give Hubot the ability to send you build status messages.
-# Install web hooks, set this sucker up with Hubot, make sure you have a port configured for him, set the HUBOT_ROOM_TO_RECEIVE_TEAM_CITY_BUILD_RESULTS
-# environment variable and Bob's your uncle you'll get build status messages from Hubot in your chat rooms.
-# All the properties aviable on the build object can be found at the properties list at the top of this file:
-# http://sourceforge.net/apps/trac/tcplugins/browser/tcWebHooks/trunk/src/main/java/webhook/teamcity/payload/format/WebHookPayloadJsonContent.java
+# Description:
+# Post
+# This script used in conjunction with tcWebHooks: http://tcplugins.sourceforge.net/info/tcWebHooks makes Hubot to send you build status messages.
+#
+# Install web hooks, set this sucker up with Hubot, make sure you have a port configured for him, and set the HUBOT_ROOM_TO_RECEIVE_TEAM_CITY_BUILD_RESULTS
+# environment variable and Bob's your uncle you'll get build status messages from Hubot in your chat rooms.
+#
+# Dependencies:
+# None
+#
+# Configuration:
+# HUBOT_ROOM_TO_RECEIVE_TEAM_CITY_BUILD_RESULTS
+#
+# Commands:
+# None
+#
+# Author:
+# cubanx
+#
+# Notes:
+# All the properties aviable on the build object can be found at the properties list at the top of this file:
+# http://sourceforge.net/apps/trac/tcplugins/browser/tcWebHooks/trunk/src/main/java/webhook/teamcity/payload/format/WebHookPayloadJsonContent.java
Robot = require('hubot').robot()
View
21 src/scripts/teamcity.coffee
@@ -1,11 +1,20 @@
-# Show status of 3 most recent builds.
+# Description:
+# Show status of 3 most recent builds.
#
-# You need to set the following variables:
-# HUBOT_TEAMCITY_USERNAME = <user name>
-# HUBOT_TEAMCITY_PASSWORD = <password>
-# HUBOT_TEAMCITY_HOSTNAME = <host : port>
+# Dependencies:
+# None
#
-# hubot show me builds - Show status of currently running builds
+# Configuration:
+# HUBOT_TEAMCITY_USERNAME = <user name>
+# HUBOT_TEAMCITY_PASSWORD = <password>
+# HUBOT_TEAMCITY_HOSTNAME = <host : port>
+#
+# Commands:
+# hubot show me builds - Show status of currently running builds
+#
+# Author:
+# assaf
+
module.exports = (robot) ->
robot.respond /show (me )?builds/i, (msg) ->
username = process.env.HUBOT_TEAMCITY_USERNAME
View
16 src/scripts/tell.coffee
@@ -1,6 +1,18 @@
-# Tell Hubot to send a user a message when present in the room
+# Description:
+# Tell Hubot to send a user a message when present in the room
#
-# hubot tell <username> <some message>
+# Dependencies:
+# None
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot tell <username> <some message> - tell <username> <some message> next time they are present
+#
+# Author:
+# christianchristensen
+
module.exports = (robot) ->
localstorage = {}
robot.respond /tell ([\w.-]*) (.*)/i, (msg) ->
View
23 src/scripts/text.coffee
@@ -1,8 +1,23 @@
-# Allows Hubot to send text messages using SMSified API.
+# Description:
+# Allows Hubot to send text messages using SMSified API.
#
-# hubot text <phonenumber> <message> - Sends <message> to <phonenumber>.
-#
-# test curl: curl -v "https://username:password@api.smsified.com/v1/smsmessaging/outbound/{senderAddress}/requests" -X POST -d "address={phonenumber}&message={hello%0Aworld}"
+# Dependencies:
+# None
+#
+# Configuration:
+# HUBOT_SMSIFIED_USERNAME
+# HUBOT_SMSIFIED_PASSWORD
+# HUBOT_SMSIFIED_SENDERADDRESS
+# None

Should this None be here? :grin:

@technicalpickles Owner

None. I mean... Nope. If this is the only one I missed after updating all these comments, then I will be quite pleased.

Not 100% sure.. but I think this is the only one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+#
+# Commands:
+# hubot text <phonenumber> <message> - Sends <message> to <phonenumber>.
+#
+# Author:
+# chrismatthieu
+#
+# Notes:
+# test curl: curl -v "https://username:password@api.smsified.com/v1/smsmessaging/outbound/{senderAddress}/requests" -X POST -d "address={phonenumber}&message={hello%0Aworld}"
QS = require "querystring"
View
13 src/scripts/thebattle.coffee
@@ -1,8 +1,17 @@
-# Display "The Battle" image
+# Description:
+# Display "The Battle" image
#
-# knowing is half the battle - display "The Battle" image
+# Dependencies:
+# None
#
+# Configuration:
+# None
#
+# Commands:
+# knowing is half the battle - display "The Battle" image
+#
+# Author:
+# coyled
thebattle = [
"http://static2.nerduo.com/thebattle_zoom.png",
View
37 src/scripts/trac.coffee
@@ -1,25 +1,34 @@
-# Trac interaction script
+# Description:
+# Trac interaction script
#
-# #123 - Show details about a Trac ticket
-# r123 or [123] - Show details about a commit
-
-# Required environment variables:
-# * HUBOT_TRAC_URL: Base URL to Trac instance, without trailing slash eg: https://myserver.com/trac
-# * HUBOT_TRAC_USER: Trac username (uses HTTP basic authentication)
-# * HUBOT_TRAC_PASSWORD: Trac password
-# Optional environment variables:
-# * HUBOT_TRAC_JSONRPC: "true" to use the Trac http://trac-hacks.org/wiki/XmlRpcPlugin.
+# Dependencies:
+# "xml2js": "0.1.14"
+#
+# Configuration:
+# HUBOT_TRAC_URL: Base URL to Trac instance, without trailing slash eg: https://myserver.com/trac
+# HUBOT_TRAC_USER: Trac username (uses HTTP basic authentication)
+# HUBOT_TRAC_PASSWORD: Trac password
+#
+# Optional Configuration:
+# HUBOT_TRAC_JSONRPC: "true" to use the Trac http://trac-hacks.org/wiki/XmlRpcPlugin.
# Requires jsonrpc to be enabled in the plugin. Default to "true".
-# * HUBOT_TRAC_SCRAPE: "true" to use HTTP scraping to pull information from Trac.
+# HUBOT_TRAC_SCRAPE: "true" to use HTTP scraping to pull information from Trac.
# Defaults to "true".
-# * HUBOT_TRAC_LINKDELAY: number of seconds to not show a link for again after it's been
+# HUBOT_TRAC_LINKDELAY: number of seconds to not show a link for again after it's been
# mentioned once. This helps to cut down on noise from the bot.
# Defaults to 30.
-# * HUBOT_TRAC_IGNOREUSERS: Comma-seperated list of users to ignore "hearing" issues from.
+# HUBOT_TRAC_IGNOREUSERS: Comma-seperated list of users to ignore "hearing" issues from.
# This works well with other bots or API calls that post to the room.
# Example: "Subversion,TeamCity,John Doe"
+# Commands:
+# #123 - Show details about a Trac ticket
+# r123 - Show details about a commit
+# [123] - Show details about a commit
#
-# A note on the JSONRPC/SCRAPE settings:
+# Author:
+# gregmac
+
+# Notes:
# * Tickets pull from jsonrpc (if enabled), then scraping (if enabled), and otherwise just put a link
# * Revisions pull from scraping (if enabled), and otherwise just post a link. (There are no xmlrpc methods
# for changeset data).
View
18 src/scripts/train.coffee
@@ -1,11 +1,19 @@
-# A way to interact with the NS (Dutch Railways) API
+# Description:
+# A way to interact with the NS (Dutch Railways) API
#
-# To configure, add HUBOT_NS_API_EMAIL and HUBOT_NS_API_PASSWORD to your Heroku config with "heroku config:add"
+# Dependencies:
+# "xml2js": "0.1.14"
#
-# hubot train disruptions <station> - Retrieve the list of disruptions near <station>.
-# Please note: <station> can be a station code (e.g. 'asd')
-# or (part of) a station name (e.g. 'Amsterdam Centraal')
+# Configuration:
+# HUBOT_NS_API_EMAIL
+# HUBOT_NS_API_PASSWORD
#
+# Commands:
+# hubot train disruptions <station> - Retrieve the list of disruptions near <station>. <station> can be a station code (e.g. 'asd') or (part of) a station name (e.g. 'Amsterdam Centraal')
+#
+# Author:
+# marceldegraaf
+
xml2js = require 'xml2js'
disruptionApiUrl = 'http://webservices.ns.nl/ns-api-storingen'
View
13 src/scripts/trajectorystorylisten.coffee
@@ -1,11 +1,18 @@
-# Listens for Trajectory story links.
+# Description:
+# Listens for Trajectory story links.
#
-# <a Trajectory story URL> - sends back some story details
+# Dependencies:
+# None
#
-# You need to set the following variables:
+# Configuration:
# HUBOT_TRAJECTORY_APIKEY: your Trajectory API key
# HUBOT_TRAJECTORY_ACCOUNT: your Trajectory account number
#
+# Commands:
+# <a Trajectory story URL> - sends back some story details
+#
+# Author:
+# galfert
module.exports = (robot) ->
robot.hear /apptrajectory\.com\/\w+\/(\w+)\/stories\/(\d+)/i, (msg) ->
apiKey = process.env.HUBOT_TRAJECTORY_APIKEY
View
14 src/scripts/travis.coffee
@@ -1,7 +1,17 @@
-# Find the build status of an open-source project on Travis
+# Description:
+# Find the build status of an open-source project on Travis
#
-# hubot travis me <user>/<repo> - Returns the build status of https://github.com/<user>/<repo>
+# Dependencies:
+# None
#
+# Configuration:
+# None
+#
+# Commands:
+# hubot travis me <user>/<repo> - Returns the build status of https://github.com/<user>/<repo>
+#
+# Author:
+# sferik
module.exports = (robot) ->
robot.respond /travis me (.*)/i, (msg) ->
View
19 src/scripts/trollicon.coffee
@@ -1,10 +1,19 @@
-# Return trollicon images
+# Description:
+# Return trollicon images
+# used resources from : https://github.com/sagargp/trollicons Adium extension
#
-# :<trollicon>: - outputs trollicon image
-# :isee: what you did there, and :megusta: - is a valid example of multiple trollicons
+# Dependencies:
+# None
#
-# by Adan Alvarado and Enrique Vidal
-# used resources from : https://github.com/sagargp/trollicons Adium extension
+# Configuration:
+# None
+#
+# Commands:
+# :<trollicon>: - outputs <trollicon> image
+# :isee: what you did there, and :megusta: - is a valid example of multiple trollicons
+#
+# Author:
+# Adan Alvarado and Enrique Vidal
trollicons = {
'gasp' : 'http://i.imgur.com/tYmuZ.png',
View
22 src/scripts/truckstopsf.coffee
@@ -1,11 +1,21 @@
-# Find out what food trucks are at Truck Stop SF today
-# See http://truckstopsf.com
+# Description:
+# Find out what food trucks are at Truck Stop SF today
+# See http://truckstopsf.com
#
-# Examples:
-# hubot truckstopsf - get just the names of the food trucks today
-# hubot truckstopsf details|deets - get food truck names and details
-# hubot truckstopsf! - get food truck names and details
+# Dependencies:
+# None
#
+# Configuration:
+# None
+#
+# Commands:
+# hubot truckstopsf - get just the names of the food trucks today
+# hubot truckstopsf details|deets - get food truck names and details
+# hubot truckstopsf! - get food truck names and details
+#
+# Author:
+# None
+
module.exports = (robot) ->
robot.respond /truckstopsf\s?(!|details|deets)?/i, (res) ->
d = new Date()
View
15 src/scripts/tryerlang.coffee
@@ -1,6 +1,17 @@
-# hubot erl <expr> - Evaluate an Erlang Expression on tryerlang.org and return the result
+# Description:
+# None
#
-# By Roberto Aloi (@robertoaloi)
+# Dependencies:
+# "querystring": "0.1.0"
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot erl <expr> - Evaluate an Erlang Expression on tryerlang.org and return the result
+#
+# Author:
+# Roberto Aloi (@robertoaloi)
QS = require "querystring"
View
18 src/scripts/tumblr.coffee
@@ -1,11 +1,19 @@
-# Display photos from a Tumblr blog
+# Description:
+# Display photos from a Tumblr blog
#
-# Environment variables:
+# Dependencies:
+# None
#
-# HUBOT_TUMBLR_BLOG_NAME
-# HUBOT_TUMBLR_API_KEY
+# Configuration:
+# HUBOT_TUMBLR_BLOG_NAME
+# HUBOT_TUMBLR_API_KEY
#
-# hubot show me tumblr <count> - Shows the latest <count> tumblr photos (default is 1)
+# Commands:
+# hubot show me tumblr <count> - Shows the latest <count> tumblr photos (default is 1)
+#
+# Author:
+# pgieser
+
module.exports = (robot) ->
blog_name = process.env.HUBOT_TUMBLR_BLOG_NAME
View
15 src/scripts/tvshow.coffee
@@ -1,3 +1,18 @@
+# Description:
+# None
+#
+# Dependencies:
+# "xml2js": "0.1.14"
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot tvshow me <show> - Show info about <show>
+#
+# Author:
+# victorbutler
+
xml2js = require "xml2js"
module.exports = (robot) ->
robot.respond /tvshow(?: me)? (.*)/i, (msg) ->
View
14 src/scripts/tweet.coffee
@@ -1,7 +1,17 @@
-# Display a random tweet from twitter about a subject
+# Description:
+# Display a random tweet from twitter about a subject
#
-# hubot <keyword> tweet - Returns a link to a tweet about <keyword>
+# Dependencies:
+# None
#
+# Configuration:
+# None
+#
+# Commands:
+# hubot <keyword> tweet - Returns a link to a tweet about <keyword>
+#
+# Author:
+# atmos
module.exports = (robot) ->
robot.respond /(.*) tweet/i, (msg) ->
View
18 src/scripts/twitter.coffee
@@ -1,4 +1,18 @@
-#gets tweet from user
+# Description:
+# gets tweet from user
+#
+# Dependencies:
+# None
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot twitter <twitter username> - Show last tweet from <twitter username>
+#
+# Author:
+# KevinTraver
+#
module.exports = (robot) ->
robot.respond /(twitter|lasttweet) (.+)$/i, (msg) ->
username = msg.match[2]
@@ -8,4 +22,4 @@ module.exports = (robot) ->
if response[0]
msg.send response[0]["text"]
else
- msg.send "Error"
+ msg.send "Error"
View
17 src/scripts/twss.coffee
@@ -1,7 +1,18 @@
-# Hubot will respond to (in)appropriate lines with "That's what she said"
+# Description:
+# Hubot will respond to (in)appropriate lines with "That's what she said"
#
-# hubot <anything related to size, speed, quality, specific body parts> - Hubot will "that's what she said" that ish
+# Dependencies:
+# None
+#
+# Configuration:
+# None
+#
+# Commands:
+# hubot <anything related to size, speed, quality, specific body parts> - Hubot will "that's what she said" that ish
+#
+# Author:
+# dhchow
module.exports = (robot) ->
robot.respond /.*(big|small|long|hard|soft|mouth|face|good|fast|slow|in there|on there|in that|on that|wet|dry|on the|in the|suck|blow|jaw|all in|fit that|fit it|hurts|hot|huge|balls|stuck)/i, (msg) ->
- msg.send "THAT'S WHAT SHE SAID!"
+ msg.send "THAT'S WHAT SHE SAID!"
Please sign in to comment.
Something went wrong with that request. Please try again.