Skip to content
Browse files

Improve help messages

This commit improves help messages for a lot of the scripts. In
particular:

 * Include hubot at the beginning of `respond`s
 * Keep help messages to one line
 * separate example and documentation by a single space, a hyphen, and
   another space (as opposed to verticaly aligning the hyphen)
  • Loading branch information...
1 parent f92b222 commit be87ca01ff59ed7378223d156a254a5665b92595 @technicalpickles technicalpickles committed
Showing with 321 additions and 333 deletions.
  1. +4 −4 src/scripts/46elks.coffee
  2. +1 −1 src/scripts/9gag.coffee
  3. +1 −1 src/scripts/abstract.coffee
  4. +1 −1 src/scripts/achievement_unlocked.coffee
  5. +1 −1 src/scripts/ambush.coffee
  6. +1 −1 src/scripts/animal.coffee
  7. +1 −1 src/scripts/ascii.coffee
  8. +4 −4 src/scripts/auth.coffee
  9. +2 −2 src/scripts/aws.coffee
  10. +2 −2 src/scripts/bang-bang.coffee
  11. +1 −1 src/scripts/bang.coffee
  12. +2 −2 src/scripts/base58.coffee
  13. +1 −1 src/scripts/base64.coffee
  14. +1 −1 src/scripts/bees.coffee
  15. +1 −1 src/scripts/bing.coffee
  16. +6 −6 src/scripts/bookmark.coffee
  17. +2 −2 src/scripts/brewerydb.coffee
  18. +2 −3 src/scripts/buscemi.coffee
  19. +2 −1 src/scripts/chat.coffee
  20. +1 −1 src/scripts/cheer.coffee
  21. +2 −2 src/scripts/cheerlights.coffee
  22. +1 −1 src/scripts/chm.coffee
  23. +3 −3 src/scripts/chuck-norris.coffee
  24. +1 −1 src/scripts/clark.coffee
  25. +1 −1 src/scripts/clojure.coffee
  26. +1 −2 src/scripts/cloudapp.coffee
  27. +2 −2 src/scripts/coderwall.coffee
  28. +1 −1 src/scripts/coin.coffee
  29. +1 −1 src/scripts/commitmessage.coffee
  30. +2 −2 src/scripts/corgime.coffee
  31. +1 −1 src/scripts/cowsay.coffee
  32. +2 −2 src/scripts/days_since.coffee
  33. +4 −4 src/scripts/deadline.coffee
  34. +2 −3 src/scripts/decide.coffee
  35. +1 −1 src/scripts/defprogramming.coffee
  36. +1 −1 src/scripts/destiny.coffee
  37. +1 −1 src/scripts/dialectizer.coffee
  38. +2 −2 src/scripts/dice.coffee
  39. +1 −1 src/scripts/dilbert.coffee
  40. +1 −1 src/scripts/directions.coffee
  41. +1 −1 src/scripts/eight-ball.coffee
  42. +1 −1 src/scripts/eval.coffee
  43. +5 −5 src/scripts/faceup.coffee
  44. +2 −2 src/scripts/filmwise.coffee
  45. +2 −2 src/scripts/flattr.coffee
  46. +1 −1 src/scripts/fortune.coffee
  47. +2 −2 src/scripts/gauges.coffee
  48. +2 −2 src/scripts/gemwhois.coffee
  49. +1 −1 src/scripts/getajob.coffee
  50. +2 −2 src/scripts/gifbin.coffee
  51. +1 −1 src/scripts/giftv.coffee
  52. +1 −1 src/scripts/github-activity.coffee
  53. +2 −2 src/scripts/github-commiters.coffee
  54. +4 −4 src/scripts/github-credentials.coffee
  55. +1 −1 src/scripts/github-issues.coffee
  56. +1 −1 src/scripts/github-pulls.coffee
  57. +1 −1 src/scripts/good-night.coffee
  58. +6 −6 src/scripts/goodbad.coffee
  59. +1 −1 src/scripts/google-reader.coffee
  60. +1 −1 src/scripts/google-search-api.coffee
  61. +1 −1 src/scripts/google.coffee
  62. +1 −1 src/scripts/hackernews.coffee
  63. +2 −2 src/scripts/hangman.coffee
  64. +3 −3 src/scripts/hardradio.coffee
  65. +2 −2 src/scripts/hashing.coffee
  66. +3 −3 src/scripts/heroku-status.coffee
  67. +3 −3 src/scripts/history.coffee
  68. +1 −1 src/scripts/insult.coffee
  69. +1 −1 src/scripts/iwdrm.coffee
  70. +1 −1 src/scripts/janky.coffee
  71. +3 −4 src/scripts/jenkins.coffee
  72. +6 −6 src/scripts/jira.coffee
  73. +1 −2 src/scripts/joinme-generator.coffee
  74. +5 −5 src/scripts/karma.coffee
  75. +3 −3 src/scripts/keep-alive.coffee
  76. +3 −3 src/scripts/kittens.coffee
  77. +1 −1 src/scripts/lastfm_np.coffee
  78. +4 −4 src/scripts/list-jira-bugs.coffee
  79. +6 −8 src/scripts/location-decision-maker.coffee
  80. +1 −1 src/scripts/lolz.coffee
  81. +1 −1 src/scripts/look-of-disapproval.coffee
  82. +1 −1 src/scripts/lyrics.coffee
  83. +1 −1 src/scripts/manatee.coffee
  84. +10 −11 src/scripts/meme_generator.coffee
  85. +2 −2 src/scripts/mitch-hedburg.coffee
  86. +2 −2 src/scripts/mite.coffee
  87. +2 −2 src/scripts/modulepuppy.coffee
  88. +2 −2 src/scripts/mta.coffee
  89. +1 −1 src/scripts/mtg.coffee
  90. +1 −1 src/scripts/nettipot.coffee
  91. +2 −2 src/scripts/newrelic.coffee
  92. +2 −2 src/scripts/news.coffee
  93. +1 −1 src/scripts/notify.coffee
  94. +2 −2 src/scripts/octocat.coffee
  95. +4 −4 src/scripts/octospy.coffee
  96. +3 −3 src/scripts/penny-arcade.coffee
  97. +2 −2 src/scripts/prank-text.coffee
  98. +1 −2 src/scripts/punchfork.coffee
  99. +2 −2 src/scripts/pypi.coffee
  100. +3 −3 src/scripts/quote.coffee
  101. +1 −1 src/scripts/rageface.coffee
  102. +2 −2 src/scripts/rally.coffee
  103. +1 −1 src/scripts/reddit-jokes.coffee
  104. +2 −2 src/scripts/reddit-random-top.coffee
  105. +1 −1 src/scripts/reddit.coffee
  106. +8 −8 src/scripts/redmine.coffee
  107. +1 −3 src/scripts/remind.coffee
  108. +1 −1 src/scripts/resque.coffee
  109. +3 −3 src/scripts/roll.coffee
  110. +8 −8 src/scripts/rollout.coffee
  111. +2 −2 src/scripts/rotten.coffee
  112. +2 −2 src/scripts/rsstodolist.coffee
  113. +1 −1 src/scripts/ruby.coffee
  114. +1 −1 src/scripts/rubygems.coffee
  115. +3 −3 src/scripts/salesforce.coffee
  116. +3 −3 src/scripts/script.coffee
  117. +4 −4 src/scripts/sendgrid.coffee
  118. +1 −1 src/scripts/shorten.coffee
  119. +1 −1 src/scripts/sigh.coffee
  120. +1 −1 src/scripts/sms.coffee
  121. +3 −3 src/scripts/snow.coffee
  122. +1 −1 src/scripts/sonos.coffee
  123. +7 −7 src/scripts/sprintly.coffee
  124. +2 −2 src/scripts/stocks.coffee
  125. +1 −1 src/scripts/sugarcrm.coffee
  126. +1 −1 src/scripts/swanson.coffee
  127. +3 −3 src/scripts/talkative.coffee
  128. +3 −3 src/scripts/tasks.coffee
  129. +2 −2 src/scripts/teamcity.coffee
  130. +1 −1 src/scripts/tell.coffee
  131. +1 −1 src/scripts/text.coffee
  132. +3 −3 src/scripts/train.coffee
  133. +1 −1 src/scripts/trajectorystorylisten.coffee
  134. +1 −1 src/scripts/travis.coffee
  135. +3 −3 src/scripts/truckstopsf.coffee
  136. +1 −1 src/scripts/tryerlang.coffee
  137. +1 −1 src/scripts/tumblr.coffee
  138. +1 −1 src/scripts/tweet.coffee
  139. +3 −3 src/scripts/uptime-robot.coffee
  140. +2 −2 src/scripts/urban.coffee
  141. +2 −2 src/scripts/url.coffee
  142. +1 −1 src/scripts/vanity.coffee
  143. +2 −2 src/scripts/walmart.coffee
  144. +1 −1 src/scripts/wat.coffee
  145. +2 −2 src/scripts/weather.coffee
  146. +1 −1 src/scripts/webshot.coffee
  147. +1 −1 src/scripts/whos-turn.coffee
  148. +1 −1 src/scripts/wikipedia.coffee
  149. +1 −1 src/scripts/wolfram.coffee
  150. +2 −2 src/scripts/word-of-the-day.coffee
  151. +3 −3 src/scripts/wordnik.coffee
  152. +4 −4 src/scripts/wunderground.coffee
  153. +5 −5 src/scripts/wunderlist.coffee
  154. +2 −2 src/scripts/xkcd.coffee
  155. +1 −1 src/scripts/xmas.js
  156. +1 −3 src/scripts/yomama.coffee
  157. +1 −1 src/scripts/yuno.coffee
View
8 src/scripts/46elks.coffee
@@ -2,9 +2,9 @@
#
# you need to set HUBOT_46ELKS_USERNAME and HUBOT_46ELKS_PASSWORD
#
-# sms <user> <message> - Sends <message> to the number <to>.
-# <user> has phone number <phone> - Sets the phone number of <user> to <phone>.
-# give me the phone number to <user> - Gets the phone number of <user>.e
+# hubot sms <user> <message> - Sends <message> to the number <to>.
+# hubot <user> has phone number <phone> - Sets the phone number of <user> to <phone>.
+# hubot give me the phone number to <user> - Gets the phone number of <user>.e
QS = require "querystring"
module.exports = (robot) ->
@@ -86,4 +86,4 @@ module.exports = (robot) ->
else if users.length > 1
msg.send getAmbiguousUserText users
else
- msg.send "I don't know anything about #{name}."
+ msg.send "I don't know anything about #{name}."
View
2 src/scripts/9gag.coffee
@@ -1,4 +1,4 @@
-# 9gag me - Returns a random meme image.
+# hubot 9gag me - Returns a random meme image.
# Random meme from 9gag
# Rewrite by Enrique Vidal
View
2 src/scripts/abstract.coffee
@@ -1,4 +1,4 @@
-# abstract <topic> - Prints a nice abstract of the given topic.
+# hubot abstract <topic> - Prints a nice abstract of the given topic.
# Copyright (c) 2011 John Tantalo
#
View
2 src/scripts/achievement_unlocked.coffee
@@ -1,5 +1,5 @@
#
-# achievement get <achievement> [achiever's gravatar email] - life goals are in reach.
+# hubot achievement get <achievement> [achiever's gravatar email] - life goals are in reach.
#
module.exports = (robot) ->
robot.hear /achievement (get|unlock(ed)?) (.+?)(\s*[^@\s]+@[^@\s]+)?\s*$/i, (msg) ->
View
2 src/scripts/ambush.coffee
@@ -1,6 +1,6 @@
# Send messages to users the next time they speak
#
-# ambush <user name>: <message>
+# hubot ambush <user name>: <message>
appendAmbush = (data, toUser, fromUser, message) ->
if data[toUser.name]
View
2 src/scripts/animal.coffee
@@ -1,6 +1,6 @@
# Because animals are animals.
#
-# animal me - Grab a random gif from http://animalsbeingdicks.com/
+# hubot animal me - Grab a random gif from http://animalsbeingdicks.com/
#
Select = require("soupselect").select
HtmlParser = require "htmlparser"
View
2 src/scripts/ascii.coffee
@@ -1,6 +1,6 @@
# ASCII art.
#
-# ascii me <text> - Show text in ascii art.
+# hubot ascii me <text> - Show text in ascii art.
module.exports = (robot) ->
robot.respond /ascii( me)? (.+)/i, (msg) ->
View
8 src/scripts/auth.coffee
@@ -1,9 +1,9 @@
# Auth allows you to assign roles to users which can be used by other scripts to restrict access to Hubot commands
#
-# <user> has <role> role - Assigns a role to a user
-# <user> doesn't have <role> role - Removes a role from a user
-# what role does <user> have - Find out what roles are assigned to a specific user
-# who has admin role - Find out who's an admin and can assign roles
+# hubot <user> has <role> role - Assigns a role to a user
+# hubot <user> doesn't have <role> role - Removes a role from a user
+# hubot what role does <user> have - Find out what roles are assigned to a specific user
+# hubot who has admin role - Find out who's an admin and can assign roles
#
# Environment variables:
# * HUBOT_AUTH_ADMIN
View
4 src/scripts/aws.coffee
@@ -1,6 +1,6 @@
# Queries for the status of AWS services
#
-# sqs status - Returns the status of SQS queues.
+# hubot sqs status - Returns the status of SQS queues.
#
# Environment variables:
@@ -75,4 +75,4 @@ module.exports = (robot) ->
else
timestamp = 'none available'
- msg.send "#{queueDesc} / oldest msg ~[#{timestamp}]", url
+ msg.send "#{queueDesc} / oldest msg ~[#{timestamp}]", url
View
4 src/scripts/bang-bang.coffee
@@ -1,4 +1,4 @@
-# !! - Repeat the last command directed at hubot
+# hubot !! - Repeat the last command directed at hubot
module.exports = (robot) ->
robot.respond /(.+)/i, (msg) ->
store msg
@@ -15,4 +15,4 @@ module.exports = (robot) ->
store = (msg) ->
command = msg.match[1].trim()
- exports.last_command = command unless command == '!!'
+ exports.last_command = command unless command == '!!'
View
2 src/scripts/bang.coffee
@@ -1,4 +1,4 @@
-# `hubot bang [--help|--list|--delete] <key> [value]` - Store and retrieve text snippets.
+# hubot bang [--help|--list|--delete] <key> [value] - Store and retrieve text snippets.
# A Hubot interface for Bang, a key-value store for text snippets
# http://git.io/bang
View
4 src/scripts/base58.coffee
@@ -1,6 +1,6 @@
# Base58 encoding and decoding.
#
-# base58 encode|decode <query> - Base58 encode or decode <query>
+# hubot base58 encode|decode <query> - Base58 encode or decode <query>
module.exports = (robot) ->
robot.respond /base58 encode( me)? (.*)/i, (msg) ->
@@ -43,4 +43,4 @@ class Base58Builder
num
-Base58 = new Base58Builder()
+Base58 = new Base58Builder()
View
2 src/scripts/base64.coffee
@@ -1,6 +1,6 @@
# Base64 encoding and decoding.
#
-# base64 encode|decode <query> - Base64 encode or decode <string>
+# hubot base64 encode|decode <query> - Base64 encode or decode <string>
module.exports = (robot) ->
robot.respond /base64 encode( me)? (.*)/i, (msg) ->
View
2 src/scripts/bees.coffee
@@ -1,6 +1,6 @@
# Bees are insane
#
-# bees - Oprah at her finest, or a good way to turn the fans on coworkers machines
+# hubot bees - Oprah at her finest, or a good way to turn the fans on coworkers machines
module.exports = (robot) ->
robot.respond /bees/i, (message) ->
View
2 src/scripts/bing.coffee
@@ -1,6 +1,6 @@
# Returns the URL of the first bing hit for a query
#
-# bing me <query> - Bings <query> & returns 1st result's URL
+# hubot bing me <query> - Bings <query> & returns 1st result's URL
module.exports = (robot) ->
robot.respond /(bing)( me)? (.*)/i, (msg) ->
View
12 src/scripts/bookmark.coffee
@@ -6,12 +6,12 @@
# DELICIOUS_USER = <Your Delicious username>
# DELICIOUS_PASSWORD = <Your Delicious password>
#
-# bookmark <url> as <description> - add a url to your delicious feed
-# link <url> as <description> - add a url to the robot brain
-# link me for <description> - find a link by description
-# list bookmarks - get a list of the 15 most recent bookmarks
-# list links - List all of the links that are being tracked
-# feed me - get the URL to subscribe to your bookmark rss
+# hubot bookmark <url> as <description> - add a url to your delicious feed
+# hubot link <url> as <description> - add a url to the robot brain
+# hubot link me for <description> - find a link by description
+# hubot list bookmarks - get a list of the 15 most recent bookmarks
+# hubot list links - List all of the links that are being tracked
+# hubot feed me - get the URL to subscribe to your bookmark rss
#
module.exports = (robot) ->
View
4 src/scripts/brewerydb.coffee
@@ -1,6 +1,6 @@
# BreweryDB API
#
-# beer me <beer name> - Information about a beer
+# hubot beer me <beer name> - Information about a beer
module.exports = (robot) ->
robot.respond /beer me (.*)/i, (msg) ->
@@ -31,4 +31,4 @@ module.exports = (robot) ->
response += "\nABV: #{beer['abv']}%"
if beer['ibu']?
response += "\nIBU: #{beer['ibu']}"
- msg.send response
+ msg.send response
View
5 src/scripts/buscemi.coffee
@@ -1,8 +1,7 @@
# HOLY FUCKING MINDFUCK!
#
-# buscemi me <url> - Adds Steve Buscemi eyes to the specified URL.
-# buscemi me <query> - Searches Google Images for the specified query and
-# buscemi's it.
+# hubot buscemi me <url> - Adds Steve Buscemi eyes to the specified URL.
+# hubot buscemi me <query> - Searches Google Images for the specified query and buscemi's it.
module.exports = (robot) ->
robot.respond /buscemi?(?: me)? (.*)/i, (msg) ->
buscemi = "http://buscemi.heroku.com?src="
View
3 src/scripts/chat.coffee
@@ -1,6 +1,7 @@
# Start up some wonderful chats with conversation starters
#
-# chat - Tell hubot to make something fun to chat about
+# hubot chat - Tell hubot to make something fun to chat about
+#
# Conversation starters graciously provided by http://Chatoms.com
module.exports = (robot) ->
View
2 src/scripts/cheer.coffee
@@ -1,6 +1,6 @@
# Feeling depressed?
#
-# cheer me up - A little pick me up
+# hubot cheer me up - A little pick me up
module.exports = (robot) ->
robot.respond /cheer me up/i, (msg) ->
aww msg
View
4 src/scripts/cheerlights.coffee
@@ -1,4 +1,4 @@
-#get last color from http://www.cheerlights.com
+# hubot cheerlights - get last color from http://www.cheerlights.com
module.exports = (robot) ->
robot.respond /cheerlights/i, (msg) ->
msg.http("http://api.thingspeak.com/channels/1417/field/1/last.json")
@@ -7,4 +7,4 @@ module.exports = (robot) ->
if response
msg.send "The last color is: " + response["field1"]
else
- msg.send "Error"
+ msg.send "Error"
View
2 src/scripts/chm.coffee
@@ -1,6 +1,6 @@
# Shows a short history lesson of the day from the Computer History Museum.
#
-# today in computer history|tdih|chm - Displays the content from the This Day in History page on the Computer History Museum site.
+# hubot today in computer history|tdih|chm - Displays the content from the This Day in History page on the Computer History Museum site.
#
Select = require("soupselect").select
HtmlParser = require "htmlparser"
View
6 src/scripts/chuck-norris.coffee
@@ -1,8 +1,8 @@
# Chuck Norris awesomness.
#
#
-# chuck norris -- random Chuck Norris awesomeness.
-# chuck norris me <user> -- let's see how <user> would do as Chuck Norris.
+# hubot chuck norris -- random Chuck Norris awesomeness.
+# hubot chuck norris me <user> -- let's see how <user> would do as Chuck Norris.
module.exports = (robot) ->
@@ -25,4 +25,4 @@ module.exports = (robot) ->
else
msg.send message_from_chuck.value.joke
-
+
View
2 src/scripts/clark.coffee
@@ -1,4 +1,4 @@
-# clark - build sparklines out of data
+# hubot clark - build sparklines out of data
clark = require('clark').clark
View
2 src/scripts/clojure.coffee
@@ -1,6 +1,6 @@
# Evaluate one line of Clojure script.
#
-# clojure|clj <script> - Evaluate one line of Clojure script
+# hubot clojure|clj <script> - Evaluate one line of Clojure script
module.exports = (robot) ->
robot.respond /(clojure|clj)\s+(.*)/i, (msg)->
script = encodeURIComponent(msg.match[2])
View
3 src/scripts/cloudapp.coffee
@@ -1,7 +1,6 @@
# Allow Hubot to show what's lurking behind a CloudApp link.
#
-# http://cl.ly/* - Detects the drop's type and displays it or prints its content
-# if it's an image or text file respectively.
+# http://cl.ly/* - Detects the drop's type and displays it or prints its content if it's an image or text file respectively.
module.exports = (robot) ->
robot.hear /(https?:\/\/cl.ly\/[A-Za-z0-9]+)(\/[^\/]+)?/i, (msg) ->
View
4 src/scripts/coderwall.coffee
@@ -1,6 +1,6 @@
# Messing around with the Coderwall API.
#
-# coderwall <coderwall username> - Returns coder achievements from coderwall.com
+# hubot coderwall <coderwall username> - Returns coder achievements from coderwall.com
#
module.exports = (robot) ->
robot.respond /(coderwall)( me)? (.*)/i, (msg) ->
@@ -21,4 +21,4 @@ module.exports = (robot) ->
profile.badges.forEach (badge) ->
resp_str += "[" + badge.name + "] - " + badge.description + "\n"
# Return response
- msg.send resp_str
+ msg.send resp_str
View
2 src/scripts/coin.coffee
@@ -1,6 +1,6 @@
# Help decide between two things
#
-# throw a coin - Gives you heads or tails
+# hubot throw a coin - Gives you heads or tails
#
thecoin = ["heads", "tails"]
View
2 src/scripts/commitmessage.coffee
@@ -1,6 +1,6 @@
# Get a random commit message
#
-# commit message - Displays a random commit message
+# hubot commit message - Displays a random commit message
module.exports = (robot) ->
robot.respond /commit message/i, (msg) ->
View
4 src/scripts/corgime.coffee
@@ -1,7 +1,7 @@
# Corgime
#
-# corgi me - Receive a corgi
-# corgi bomb N - get N corgis
+# hubot corgi me - Receive a corgi
+# hubot corgi bomb N - get N corgis
module.exports = (robot) ->
View
2 src/scripts/cowsay.coffee
@@ -1,6 +1,6 @@
# Cowsay.
#
-# cowsay <statement> - Returns a cow that says what you want.
+# hubot cowsay <statement> - Returns a cow that says what you want.
module.exports = (robot) ->
robot.respond /cowsay( me)? (.*)/i, (msg) ->
View
4 src/scripts/days_since.coffee
@@ -1,7 +1,7 @@
# Generates commands to track days since an event
#
-# it's been <number> days since <event> - Set the day when the event happened
-# how long since <event>? - Display the number of days since the event
+# hubot it's been <number> days since <event> - Set the day when the event happened
+# hubot how long since <event>? - Display the number of days since the event
module.exports = (robot) ->
robot.respond /it's been (\d+) days since\s+(.*?)[.?!]?$/i, (msg) ->
View
8 src/scripts/deadline.coffee
@@ -1,9 +1,9 @@
# Tracks when stuff is due.
#
-# deadlines - List what you have due
-# add deadline 2011-10-30 Thing - Add a deadline for October 10, 2011
-# remove deadline Thing - Remove a deadline named "Thing"
-# clear deadlines - Remove all the deadlines
+# hubot deadlines - List what you have due
+# hubot add deadline 2011-10-30 Thing - Add a deadline for October 10, 2011
+# hubot remove deadline Thing - Remove a deadline named "Thing"
+# hubot clear deadlines - Remove all the deadlines
#
# Written by @jmhobbs
View
5 src/scripts/decide.coffee
@@ -1,7 +1,6 @@
# Allows Hubot to help you decide between multiple options.
#
-# decide "<option1>" "<option2>" "<optionx>" - Randomly picks an option.
-# More fun than using a coin.
+# hubot decide "<option1>" "<option2>" "<optionx>" - Randomly picks an option. More fun than using a coin.
#
# Examples:
#
@@ -12,4 +11,4 @@
module.exports = (robot) ->
robot.respond /decide "(.*)"/i, (msg) ->
options = msg.match[1].split('" "')
- msg.reply("Definitely \"#{ msg.random options }\".")
+ msg.reply("Definitely \"#{ msg.random options }\".")
View
2 src/scripts/defprogramming.coffee
@@ -1,4 +1,4 @@
-# def programming - Display a random programming quote from defprogramming.com
+# hubot def programming - Display a random programming quote from defprogramming.com
Select = require("soupselect").select
HtmlParser = require "htmlparser"
View
2 src/scripts/destiny.coffee
@@ -1,6 +1,6 @@
# Is it the day ?
#
-# is it <action> day ? - Returns if it's the day for your action.
+# hubot is it <action> day ? - Returns if it's the day for your action.
#
module.exports = (robot) ->
robot.respond /is it (\w+) day \?/i, (msg) ->
View
2 src/scripts/dialectizer.coffee
@@ -1,6 +1,6 @@
# Allows Hubot to translate text into various dialects.
#
-# dialectize|dialect|dia <dialect>|help <text> - Translates the given text into the given dialect.
+# hubot dialectize|dialect|dia <dialect>|help <text> - Translates the given text into the given dialect.
#
Select = require("soupselect").select
HtmlParser = require "htmlparser"
View
4 src/scripts/dice.coffee
@@ -1,8 +1,8 @@
# Allows Hubot to roll dice.
#
-# roll dice - Roll two six-sided dice.
+# hubot roll dice - Roll two six-sided dice.
#
-# roll <x>d<y> - roll x dice, each of which has y sides.
+# hubot roll <x>d<y> - roll x dice, each of which has y sides.
module.exports = (robot) ->
robot.respond /roll dice/i, (msg) ->
View
2 src/scripts/dilbert.coffee
@@ -1,6 +1,6 @@
# Dilbert
#
-# show me dilbert - gets the daily dilbert
+# hubot show me dilbert - gets the daily dilbert
htmlparser = require "htmlparser"
View
2 src/scripts/directions.coffee
@@ -1,6 +1,6 @@
# Get directions between two locations
#
-# get directions "<origin>" "<destination>" -- Shows directions between these locations.
+# hubot get directions "<origin>" "<destination>" -- Shows directions between these locations.
parse_directions = (body) ->
directions = JSON.parse body
View
2 src/scripts/eight-ball.coffee
@@ -1,6 +1,6 @@
# The Magic Eight ball
#
-# eightball <query> - Ask the magic eight ball a question
+# hubot eightball <query> - Ask the magic eight ball a question
#
ball = [
View
2 src/scripts/eval.coffee
@@ -1,6 +1,6 @@
# evaluate code.
#
-# eval me <lang> <code> - evaluate <code> and show the result.
+# hubot eval me <lang> <code> - evaluate <code> and show the result.
module.exports = (robot) ->
robot.respond /eval( me)? ([^ ]+) (.+)/i, (msg) ->
View
10 src/scripts/faceup.coffee
@@ -1,9 +1,9 @@
# Overlay funny things on people's faces
#
-# hipster me <img> - Overlay hipster glasses on a face.
-# clown me <img> - Overlay a clown nose on a face.
-# scumbag me <img> - Overlay a scumbag on a face.
-# jason me <img> - Overlay a jason on a face.
+# hubot hipster me <img> - Overlay hipster glasses on a face.
+# hubot clown me <img> - Overlay a clown nose on a face.
+# hubot scumbag me <img> - Overlay a scumbag on a face.
+# hubot jason me <img> - Overlay a jason on a face.
module.exports = (robot) ->
robot.respond /(hipster|clown|scumbag|rohan|jason)( me)? (.*)/i, (msg) ->
@@ -23,4 +23,4 @@ imageMe = (msg, query, cb) ->
images = JSON.parse(body)
images = images.responseData.results
image = msg.random images
- cb "#{image.unescapedUrl}"
+ cb "#{image.unescapedUrl}"
View
4 src/scripts/filmwise.coffee
@@ -1,7 +1,7 @@
# Show random filewise invisible
#
-# filmwise me - a randomly selected filmwise invisible
-# filmwise bomb me <number> - filmwise invisible explosion!
+# hubot filmwise me - a randomly selected filmwise invisible
+# hubot filmwise bomb me <number> - filmwise invisible explosion!
module.exports = (robot) ->
robot.respond /filmwise\s*(?:me)?$/i, (msg) ->
View
4 src/scripts/flattr.coffee
@@ -1,8 +1,8 @@
# Interact with the Flattr API.
#
# thing me <id> - Returns information about a flattr thing
-# user me <username> - Returns information about a flattr user
-# search things <query> - Search flattrs things
+# hubot user me <username> - Returns information about a flattr user
+# hubot search things <query> - Search flattrs things
#
module.exports = (robot) ->
View
2 src/scripts/fortune.coffee
@@ -1,6 +1,6 @@
# Get a fortune
#
-# fortune me - Displays a super true fortune
+# hubot fortune me - Displays a super true fortune
module.exports = (robot) ->
robot.respond /(fortune)( me)?/i, (msg) ->
View
4 src/scripts/gauges.coffee
@@ -1,8 +1,8 @@
# Allows Hubot to fetch statistics from Gaug.es
#
-# gauges for (today|yesterday) - Get views/people from today or yesterday.
+# hubot gauges for (today|yesterday) - Get views/people from today or yesterday.
#
-# gauges for YYYY-MM-DD - Get views/people for the specified date.
+# hubot gauges for YYYY-MM-DD - Get views/people for the specified date.
#
class Gauges
View
4 src/scripts/gemwhois.coffee
@@ -1,6 +1,6 @@
# Whois for gems, because gem names are like domains in the 90's
#
-# gem whois <gemname> - returns gem details if it exists
+# hubot gem whois <gemname> - returns gem details if it exists
#
module.exports = (robot) ->
@@ -19,4 +19,4 @@ module.exports = (robot) ->
documentation: #{json.documentation_uri}\n
source code: #{json.source_code_uri}\n"
catch err
- msg.send "Gem not found. It will be mine. Oh yes. It will be mine. *sinister laugh*"
+ msg.send "Gem not found. It will be mine. Oh yes. It will be mine. *sinister laugh*"
View
2 src/scripts/getajob.coffee
@@ -1,6 +1,6 @@
# Search for a job and profit!
#
-# find me a <technology> job in <location>
+# hubot find me a <technology> job in <location>
module.exports = (robot) ->
robot.respond /find me a (.* )?job( in (.+))?/i, (msg) ->
View
4 src/scripts/gifbin.coffee
@@ -1,7 +1,7 @@
-# gifbin me - Return random gif from gifbin.com
+# hubot gifbin me - Return random gif from gifbin.com
# Random gif from gifbin.com
-# Enrique Vidal - enrique@cloverinteractive.com
+# Enrique Vidal, enrique@cloverinteractive.com
Select = require( "soupselect" ).select
HTMLParser = require "htmlparser"
View
2 src/scripts/giftv.coffee
@@ -1,6 +1,6 @@
# Return random animated GIFs from giftv.
#
-# giftv me - Returns a random animated GIF.
+# hubot giftv me - Returns a random animated GIF.
module.exports = (robot) ->
robot.respond /giftv( me)?$/i, (msg) ->
msg
View
2 src/scripts/github-activity.coffee
@@ -1,6 +1,6 @@
# It was based on github-issues.coffee script
#
-# repo show <repo> - shows activity of repository
+# hubot repo show <repo> - shows activity of repository
# Add "date-utils":">=1.2.5" in the hubot-scripts.json file
#
View
4 src/scripts/github-commiters.coffee
@@ -1,7 +1,7 @@
# Show the commiters from a repo
#
-# repo commiters <repo> - shows commiters of repository
-# repo top-commiters <repo> - shows top commiters of repository
+# hubot repo commiters <repo> - shows commiters of repository
+# hubot repo top-commiters <repo> - shows top commiters of repository
# You need to set the following variables:
# HUBOT_GITHUB_TOKEN ="<oauth token>"
View
8 src/scripts/github-credentials.coffee
@@ -1,10 +1,10 @@
# Github Credentials allows you to map your user against your GitHub user.
# This is specifically in order to work with apps that have GitHub Oauth users.
#
-# who do you know - List all the users with github logins tracked by Hubot
-# i am `maddox` - map your user to the github login `maddox`
-# who am i - reveal your mapped github login
-# forget me - de-map your user to your github login
+# hubot who do you know - List all the users with github logins tracked by Hubot
+# hubot i am `maddox` - map your user to the github login `maddox`
+# hubot who am i - reveal your mapped github login
+# hubot forget me - de-map your user to your github login
module.exports = (robot) ->
View
2 src/scripts/github-issues.coffee
@@ -18,7 +18,7 @@
# 'johndoe1', you can ask `show john's issues` instead of `show johndoe1's
# issues`. This is useful for mapping chat handles to GitHub logins.
#
-# show [me] [<limit> [of]] [<assignee>'s|my] [<label>] issues [for <user/repo>] [about <query>] -- Shows open GitHub issues for repo.
+# hubot show [me] [<limit> [of]] [<assignee>'s|my] [<label>] issues [for <user/repo>] [about <query>] -- Shows open GitHub issues for repo.
_ = require("underscore")
_s = require("underscore.string")
View
2 src/scripts/github-pulls.coffee
@@ -10,7 +10,7 @@
# You can further filter pull request title by providing a reguar expression. For exmaple,
# `show me hubot pulls with awesome fix`.
#
-# show me <user/repo> pulls [with <regular expression>] - Shows open pull requests for that project by filtering pull request's title.
+# hubot show me <user/repo> pulls [with <regular expression>] - Shows open pull requests for that project by filtering pull request's title.
module.exports = (robot) ->
github = require("githubot")(robot)
robot.respond /show\s+(me\s+)?(.*)\s+pulls(\s+with\s+)?(.*)?/i, (msg)->
View
2 src/scripts/good-night.coffee
@@ -27,7 +27,7 @@ ways_to_say_good_night = [
# Make sure that hubot says good night
#
-# good night - Make sure hubot replies
+# hubot good night - Make sure hubot replies
module.exports = (robot) ->
robot.respond /(good night|bye|nighty night)/i, (msg) ->
randomNumber = Math.ceil Math.random() * ways_to_say_good_night.length
View
12 src/scripts/goodbad.coffee
@@ -1,12 +1,12 @@
# Allows good and bad things to be added to Hubot for sprint retrospective
# Based on tasks.coffee
#
-# good <good thing> - Add something good that happened this sprint
-# bad <bad thing> - Add something bad that happened this sprint
-# goodlist - List all good things that happened
-# badlist - List all bad things that happened
-# gooddel - Delete all good things that happened
-# baddel - Delete all bad things that happened
+# hubot good <good thing> - Add something good that happened this sprint
+# hubot bad <bad thing> - Add something bad that happened this sprint
+# hubot goodlist - List all good things that happened
+# hubot badlist - List all bad things that happened
+# hubot gooddel - Delete all good things that happened
+# hubot baddel - Delete all bad things that happened
class GoodBad
constructor: (@robot) ->
View
2 src/scripts/google-reader.coffee
@@ -1,7 +1,7 @@
# Subscribe to a feed in Google Reader, requires you set
# GOOGLE_USERNAME & GOOGLE_PASSWORD environment variables
#
-# subscribe <domainname> - returns whether you've subscribed succesfully
+# hubot subscribe <domainname> - returns whether you've subscribed succesfully
#
module.exports = (robot) ->
View
2 src/scripts/google-search-api.coffee
@@ -5,7 +5,7 @@
#
# Limits for free version is 100 queries per day per API key.
#
-# (google|search)( me) <query> - returns URL's and Title's for 5 first results from custom search#
+# hubot (google|search)( me) <query> - returns URL's and Title's for 5 first results from custom search#
#
module.exports = (robot) ->
robot.respond /(google|search)( me)? (.*)/i, (msg) ->
View
2 src/scripts/google.coffee
@@ -1,6 +1,6 @@
# Returns the URL of the first google hit for a query
#
-# google me <query> - Googles <query> & returns 1st result's URL
+# hubot google me <query> - Googles <query> & returns 1st result's URL
module.exports = (robot) ->
robot.respond /(google)( me)? (.*)/i, (msg) ->
View
2 src/scripts/hackernews.coffee
@@ -1,6 +1,6 @@
# Hacker News
#
-# hn top <N> - get the top N items on hacker news (or your favorite RSS feed)
+# hubot hn top <N> - get the top N items on hacker news (or your favorite RSS feed)
# hn.top - refer to the top item on hn
# hn[i] - refer to the ith item on hn
NodePie = require("nodepie")
View
4 src/scripts/hangman.coffee
@@ -1,8 +1,8 @@
# The game of Hangman.
# Words and definitions are sourced via the Wordnik API. You'll need an API key from http://developer.wordnik.com/
#
-# hangman - Display the state of the current game.
-# hangman <letterOrWord> - Make a guess.
+# hubot hangman - Display the state of the current game.
+# hubot hangman <letterOrWord> - Make a guess.
class Game
View
6 src/scripts/hardradio.coffee
@@ -1,7 +1,7 @@
# See what's playing on the Heavy Metal Supersite
#
-# hardradio song - Display the song that's rocking on air
-# hardradio listen - Displays a link to play the radio
+# hubot hardradio song - Display the song that's rocking on air
+# hubot hardradio listen - Displays a link to play the radio
#
module.exports = (robot) ->
@@ -12,4 +12,4 @@ module.exports = (robot) ->
msg.http('http://axl.hardradio.com/playnow.txt')
.get() (err, res, body) ->
body = body.replace(/song=/g, "Tearing your speakers right now: ")
- msg.send body
+ msg.send body
View
4 src/scripts/hashing.coffee
@@ -1,6 +1,6 @@
# Various hashing algorithms.
#
-# md5|sha|sha1|sha256|sha512|rmd160 me <string> - Generate hash of <string>
+# hubot md5|sha|sha1|sha256|sha512|rmd160 me <string> - Generate hash of <string>
crypto = require 'crypto'
@@ -25,4 +25,4 @@ module.exports = (robot) ->
# hex digest helper
hexDigest = (str, algo) ->
- crypto.createHash(algo).update(str, 'utf8').digest('hex')
+ crypto.createHash(algo).update(str, 'utf8').digest('hex')
View
6 src/scripts/heroku-status.coffee
@@ -1,8 +1,8 @@
# Show current Heroku status and issues
#
-# heroku status - Returns the current Heroku status for app operations and tools
-# heroku status issues <limit> - Returns a list of recent <limit> issues (default limit is 5)
-# heroku status issue <id> - Returns a single issue by ID number
+# hubot heroku status - Returns the current Heroku status for app operations and tools
+# hubot heroku status issues <limit> - Returns a list of recent <limit> issues (default limit is 5)
+# hubot heroku status issue <id> - Returns a single issue by ID number
module.exports = (robot) ->
robot.respond /heroku status$/i, (msg) ->
View
6 src/scripts/history.coffee
@@ -5,8 +5,8 @@
#
# If HUBOT_HISTORY_LINES is not set, 10 lines will be kept by default.
#
-# show [<lines> lines of] history -- Shows <lines> of history, otherwise all history.
-# clear history -- Clears the history
+# hubot show [<lines> lines of] history -- Shows <lines> of history, otherwise all history.
+# hubot clear history -- Clears the history
class History
constructor: (@robot, @keep) ->
@@ -67,4 +67,4 @@ module.exports = (robot) ->
robot.respond /clear history/i, (msg) ->
msg.send "Ok, I'm clearing the history."
- history.clear()
+ history.clear()
View
2 src/scripts/insult.coffee
@@ -1,4 +1,4 @@
-# insult <name> - give <name> the what-for
+# hubot insult <name> - give <name> the what-for
module.exports = (robot) ->
robot.respond /insult (.*)/i, (msg) ->
View
2 src/scripts/iwdrm.coffee
@@ -1,7 +1,7 @@
# Pulls a movie gif from the best tumblog
# Requires HUBOT_TUMBLR_API_KEY
#
-# movie me - Displays a moving still from IWDRM
+# hubot movie me - Displays a moving still from IWDRM
module.exports = (robot) ->
robot.respond /(movie|iwdrm)( me)?( .*)/i, (msg) ->
View
2 src/scripts/janky.coffee
@@ -1,6 +1,6 @@
# Janky API integration. https://github.com/github/janky
#
-# ci - show usage
+# hubot ci - show usage
URL = require "url"
url = URL.parse(process.env.HUBOT_JANKY_URL)
View
7 src/scripts/jenkins.coffee
@@ -6,10 +6,9 @@
# The following variables are optional
# HUBOT_JENKINS_AUTH: for authenticating the trigger request (user:password)
#
-# jenkins build <job> - builds the specified Jenkins job
-# jenkins build <job>, <params> - builds the specified Jenkins job with parameters as key=value&key2=value2
-# jenkins list - lists Jenkins jobs
-#
+# hubot jenkins build <job> - builds the specified Jenkins job
+# hubot jenkins build <job>, <params> - builds the specified Jenkins job with parameters as key=value&key2=value2
+# hubot jenkins list - lists Jenkins jobs
querystring = require 'querystring'
View
12 src/scripts/jira.coffee
@@ -1,12 +1,12 @@
# Messing with the JIRA REST API
#
# <Project Key>-<Issue ID> - Displays information about the ticket (if it exists)
-# show watchers for <Issue Key> - Shows watchers for the given issue
-# search for <JQL> - Search JIRA with JQL
-# save filter <JQL> as <name> - Save JQL as filter in the brain
-# use filter - Use a filter from the brain
-# show filter(s) - Show all filters
-# show filter <name> - Show a specific filter
+# hubot show watchers for <Issue Key> - Shows watchers for the given issue
+# hubot search for <JQL> - Search JIRA with JQL
+# hubot save filter <JQL> as <name> - Save JQL as filter in the brain
+# hubot use filter - Use a filter from the brain
+# hubot show filter(s) - Show all filters
+# hubot show filter <name> - Show a specific filter
# Required environment variables:
# * HUBOT_JIRA_URL: Base URL to JIRA instance, without trailing slash eg: https://myserver.com/jira
View
3 src/scripts/joinme-generator.coffee
@@ -1,7 +1,6 @@
# Integrates with join.me
#
-# joinme - Generates a new join.me 9-digit code and outputs a presenter link (download)
-# and a participant link (to view the session)
+# hubot joinme - Generates a new join.me 9-digit code and outputs a presenter link (download) and a participant link (to view the session)
#
module.exports = (robot) ->
View
10 src/scripts/karma.coffee
@@ -2,10 +2,10 @@
#
# <thing>++ - give thing some karma
# <thing>-- - take away some of thing's karma
-# karma <thing> - check thing's karma (if <thing> is omitted, show the top 5)
-# karma empty <thing> - empty a thing's karma
-# karma best - show the top 5
-# karma worst - show the bottom 5
+# hubot karma <thing> - check thing's karma (if <thing> is omitted, show the top 5)
+# hubot karma empty <thing> - empty a thing's karma
+# hubot karma best - show the top 5
+# hubot karma worst - show the bottom 5
class Karma
constructor: (@robot) ->
@@ -94,4 +94,4 @@ module.exports = (robot) ->
match = msg.match[1].toLowerCase()
if match != "best" && match != "worst"
msg.send "\"#{match}\" has #{karma.get(match)} karma."
-
+
View
6 src/scripts/keep-alive.coffee
@@ -1,9 +1,9 @@
# keep-alive pings each url in the array every minute.
# This is specifically to keep certain heroku apps from going to sleep
#
-# keep `http://ninjas-20.herokuapp.com` alive - Add inputted url to the collection of urls set to be pinged
-# don't keep `http://ninjas-20.herokuapp.com` alive - Remove inputted url to the collection of urls set to be pinged
-# what are you keeping alive - Show list of urls being kept alive
+# hubot keep `http://ninjas-20.herokuapp.com` alive - Add inputted url to the collection of urls set to be pinged
+# hubot don't keep `http://ninjas-20.herokuapp.com` alive - Remove inputted url to the collection of urls set to be pinged
+# hubot what are you keeping alive - Show list of urls being kept alive
HTTP = require "http"
View
6 src/scripts/kittens.coffee
@@ -1,9 +1,9 @@
# Kittens!
#
-# kitten me - A randomly selected kitten
-# kitten me <w>x<h> - A kitten of the given size
-# kitten bomb me <number> - Many many kittens!
+# hubot kitten me - A randomly selected kitten
+# hubot kitten me <w>x<h> - A kitten of the given size
+# hubot kitten bomb me <number> - Many many kittens!
module.exports = (robot) ->
robot.respond /kittens?(?: me)?$/i, (msg) ->
View
2 src/scripts/lastfm_np.coffee
@@ -1,6 +1,6 @@
# Last (or current) played song by a user in Last.fm
#
-# hubot <what's playing> someone - Returns song name and artist
+# hubot what's playing <last FM user> - Returns song name and artist
#
module.exports = (robot) ->
View
8 src/scripts/list-jira-bugs.coffee
@@ -7,10 +7,10 @@
# HUBOT_JIRA_ISSUE_TYPES
# HUBOT_JIRA_ISSUE_PRIORITIES
#
-# list my bugs - Retrieve the list of all a user's bugs from JIRA ('my' is optional)
-# list my bugs about <searchterm> - Retrieve list of all a user's bugs from JIRA where the summary or description field contains <phrase> ('my' is optional)
-# list my <priority> priority bugs - Retrieve the list of a user's <priority> priority bugs from JIRA ('my' is optional)
-# list my <priority> priority bugs about <phrase> - Retrieve list of all a user's <priority> priority bugs from JIRA where the summary or description field contains <phrase> ('my' is optional)
+# hubot list my bugs - Retrieve the list of all a user's bugs from JIRA ('my' is optional)
+# hubot list my bugs about <searchterm> - Retrieve list of all a user's bugs from JIRA where the summary or description field contains <phrase> ('my' is optional)
+# hubot list my <priority> priority bugs - Retrieve the list of a user's <priority> priority bugs from JIRA ('my' is optional)
+# hubot list my <priority> priority bugs about <phrase> - Retrieve list of all a user's <priority> priority bugs from JIRA where the summary or description field contains <phrase> ('my' is optional)
#
# e.g. "bug|task|sub task|support ticket|new feature|epic"
View
14 src/scripts/location-decision-maker.coffee
@@ -1,12 +1,10 @@
# Decides where you should go.
#
-# These commands are grabbed from comment blocks at the top of each file.
-#
-# remember <location> as a <group> location - Remembers the location for the group.
-# forget <location> as a <group> location - Forgets the location from the group.
-# forget all locations for <group> - Forgets all the locations for the group.
-# where can we go for <group>? - Returns a list of places that exist for the group.
-# where should we go for <group>? - Returns a randomly selected location for the group.
+# hubot remember <location> as a <group> location - Remembers the location for the group.
+# hubot forget <location> as a <group> location - Forgets the location from the group.
+# hubot forget all locations for <group> - Forgets all the locations for the group.
+# hubot where can we go for <group>? - Returns a list of places that exist for the group.
+# hubot where should we go for <group>? - Returns a randomly selected location for the group.
class Locations
constructor: (@robot) ->
@@ -72,4 +70,4 @@ module.exports = (robot) ->
else
location = msg.random grouplocations
- msg.send "I think you should go to #{location}"
+ msg.send "I think you should go to #{location}"
View
2 src/scripts/lolz.coffee
@@ -1,4 +1,4 @@
-# lulz - BRING THE LOLZ from bukk.it
+# hubot lulz - BRING THE LOLZ from bukk.it
Select = require("soupselect").select
HtmlParser = require "htmlparser"
View
2 src/scripts/look-of-disapproval.coffee
@@ -1,6 +1,6 @@
# Allows Hubot to give a look of disapproval.
#
-# lod <name> - gives back the character for the look of disapproval, optionally @name.
+# hubot lod <name> - gives back the character for the look of disapproval, optionally @name.
module.exports = (robot) ->
robot.respond /lod\s?(.*)/i, (msg) ->
View
2 src/scripts/lyrics.coffee
@@ -1,7 +1,7 @@
# Grabs snippets of song lyrics.
# Limited to snippets due to copyright stuff.
#
-# lyrics for <song> by <artist> - returns snippet of lyrics for this song
+# hubot lyrics for <song> by <artist> - returns snippet of lyrics for this song
#
# Example: lyrics for purple haze by jimi hendrix
module.exports = (robot) ->
View
2 src/scripts/manatee.coffee
@@ -1,6 +1,6 @@
# Allows Hubot to pull down images from clamingmanatee.com
#
-# manatee - outputs a random manatee
+# hubot manatee - outputs a random manatee
#
#
View
21 src/scripts/meme_generator.coffee
@@ -1,27 +1,26 @@
# Integrates with memegenerator.net
#
-# Y U NO <text> - Generates the Y U NO GUY with the bottom caption
-# of <text>
+# hubot Y U NO <text> - Generates the Y U NO GUY with the bottom caption of <text>
#
-# I don't always <something> but when i do <text> - Generates The Most Interesting man in the World
+# hubot I don't always <something> but when i do <text> - Generates The Most Interesting man in the World
#
-# <text> ORLY? - Generates the ORLY? owl with the top caption of <text>
+# hubot <text> ORLY? - Generates the ORLY? owl with the top caption of <text>
#
-# <text> (SUCCESS|NAILED IT) - Generates success kid with the top caption of <text>
+# hubot <text> (SUCCESS|NAILED IT) - Generates success kid with the top caption of <text>
#
-# <text> ALL the <things> - Generates ALL THE THINGS
+# hubot <text> ALL the <things> - Generates ALL THE THINGS
#
-# <text> TOO DAMN <high> - Generates THE RENT IS TOO DAMN HIGH guy
+# hubot <text> TOO DAMN <high> - Generates THE RENT IS TOO DAMN HIGH guy
#
# Good news everyone! <news> - Generates Professor Farnsworth
#
-# khanify <text> - TEEEEEEEEEEEEEEEEEXT!
+# hubot khanify <text> - TEEEEEEEEEEEEEEEEEXT!
#
-# Not sure if <text> or <text> - Generates Futurama Fry
+# hubot Not sure if <text> or <text> - Generates Futurama Fry
#
-# Yo dawg <text> so <text> - Generates Yo Dawg
+# hubot Yo dawg <text> so <text> - Generates Yo Dawg
#
-# ALL YOUR <text> ARE BELONG TO US - Generates Zero Wing with the caption of <text>
+# hubot ALL YOUR <text> ARE BELONG TO US - Generates Zero Wing with the caption of <text>
module.exports = (robot) ->
robot.respond /Y U NO (.+)/i, (msg) ->
View
4 src/scripts/mitch-hedburg.coffee
@@ -1,7 +1,7 @@
# Allows Hubot to find an awesome Mitch Hedburg quotes
#
-# get mitch - This spits out one of the many awesome Mitch Hedburg quotes from wikiquote.org with filter
-# get dirty mitch - This spits out one of the many awesome Mitch Hedburg quotes from wikiquote.org without potty mouth filter
+# hubot get mitch - This spits out one of the many awesome Mitch Hedburg quotes from wikiquote.org with filter
+# hubot get dirty mitch - This spits out one of the many awesome Mitch Hedburg quotes from wikiquote.org without potty mouth filter
# REQUIRED MODULES
# sudo npm install htmlparser
View
4 src/scripts/mite.coffee
@@ -1,7 +1,7 @@
# Allows Hubot to start and stop project time in mite.yo.lk
#
-# save my mite key <key> for <account> - stores your personal API key for mite.yo.lk
-# mite me <task> on <project> - starts or stops the matched task on the given project in mite.yo.lk
+# hubot save my mite key <key> for <account> - stores your personal API key for mite.yo.lk
+# hubot mite me <task> on <project> - starts or stops the matched task on the given project in mite.yo.lk
module.exports = (robot) ->
robot.respond /mite( me)? (.+) on (.+)/i, (msg) -> # user wants to track time
View
4 src/scripts/modulepuppy.coffee
@@ -1,8 +1,8 @@
# Find a Drupal module using modulepuppy.heroku.com
#
-# <there's a module for> that
+# hubot there's a module for <that>
# or
-# <module me> something - Returns links to modules or themes on drupal.org
+# hubot module me <something> - Returns links to modules or themes on drupal.org
module.exports = (robot) ->
robot.hear /there's a module for (.*)/i, (msg) ->
View
4 src/scripts/mta.coffee
@@ -1,7 +1,7 @@
#
# See the status of NYC subways
#
-# mta me <train> - the status of a nyc subway line
+# hubot mta me <train> - the status of a nyc subway line
#
xml2js = require('xml2js')
@@ -31,4 +31,4 @@ mtaMe = (msg) ->
else
msg.send 'the ' + str + ' train is all kinds of messed up'
else
- msg.send 'thats not a valid subway line!'
+ msg.send 'thats not a valid subway line!'
View
2 src/scripts/mtg.coffee
@@ -1,7 +1,7 @@
#
# Insert Pictures of Magic: The Gathering Cards
#
-# cast <card name> - a picture of the named magic card
+# hubot cast <card name> - a picture of the named magic card
querystring = require 'querystring';
View
2 src/scripts/nettipot.coffee
@@ -1,5 +1,5 @@
#
-# nettipot - Send scarring, horrifying image of a nettipot in use.
+# hubot nettipot - Send scarring, horrifying image of a nettipot in use.
# Written by @alexpgates
#
View
4 src/scripts/newrelic.coffee
@@ -17,7 +17,7 @@
# - Allow you to specify the name of the app to fetch metrics for:
# hubot newrelic me "My App Name"
#
-# hubot <newrelic me> - Returns summary application stats from New Relic
+# hubot newrelic me - Returns summary application stats from New Relic
module.exports = (robot) ->
robot.respond /newrelic me/i, (msg) ->
accountId = process.env.HUBOT_NEWRELIC_ACCOUNT_ID
@@ -33,4 +33,4 @@ module.exports = (robot) ->
(new Parser).parseString body, (err, json)->
for threshold_value in json['threshold_value']
msg.send " #{threshold_value['@']['name']} : #{threshold_value['@']['formatted_metric_value']}"
- msg.send " https://rpm.newrelic.com/accounts/#{accountId}/applications/#{appId}"
+ msg.send " https://rpm.newrelic.com/accounts/#{accountId}/applications/#{appId}"
View
4 src/scripts/news.coffee
@@ -1,7 +1,7 @@
# Returns the latest news headlines from Google
#
-# news - Get the latest headlines
-# news <topic> - Get the latest headlines for a specific topic
+# hubot news - Get the latest headlines
+# hubot news <topic> - Get the latest headlines for a specific topic
module.exports = (robot) ->
robot.respond /news(?: me| on)?\s?(.*)/, (msg) ->
View
2 src/scripts/notify.coffee
@@ -69,4 +69,4 @@ module.exports = (robot) ->
robot.respond /list notifiers/i, (msg) ->
for username, apikey of robot.brain.data.notifiers
- msg.send("I notify #{username} with #{apikey}")
+ msg.send("I notify #{username} with #{apikey}")
View
4 src/scripts/octocat.coffee
@@ -1,7 +1,7 @@
# Show random octocat
#
-# octocat me - a randomly selected octocat
-# octocat bomb me <number> - octocat-splosion!
+# hubot octocat me - a randomly selected octocat
+# hubot octocat bomb me <number> - octocat-splosion!
xml2js = require('xml2js')
View
8 src/scripts/octospy.coffee
@@ -1,10 +1,10 @@
# Octospy GitHub events, watch what's happening with your projects
# Powered by http://developer.github.com/v3/repos/hooks/
#
-# octospy <repo> [event_type] - Start watching events for the repo, default push
-# octospy stop <repo> [event_type] - Stop watching events for the repo
-# octospying - Show what you're spying on
-# octospy events - List the events you can watch
+# hubot octospy <repo> [event_type] - Start watching events for the repo, default push
+# hubot octospy stop <repo> [event_type] - Stop watching events for the repo
+# hubot octospying - Show what you're spying on
+# hubot octospy events - List the events you can watch
#
# Environment Variables:
View
6 src/scripts/penny-arcade.coffee
@@ -1,7 +1,7 @@
# Who doesnt love Penny Arcade?
#
-# pa - The latest Penny Arcade comic
-# pa <date> - Penny Arcade comic from <date> - mm/dd/yyyy format
+# hubot pa - The latest Penny Arcade comic
+# hubot pa <date> - Penny Arcade comic from <date> - mm/dd/yyyy format
htmlparser = require "htmlparser"
Select = require("soupselect").select
@@ -23,4 +23,4 @@ module.exports = (robot) ->
comic = img[0].attribs
msg.send comic.src
- msg.send comic.alt
+ msg.send comic.alt
View
4 src/scripts/prank-text.coffee
@@ -1,7 +1,7 @@
# Prank text a friend (or enemy)
#
-# drunk-text <number> - send a text to <number>
-# prank-text <number> - send a text to <number>
+# hubot drunk-text <number> - send a text to <number>
+# hubot prank-text <number> - send a text to <number>
#
HTMLParser = require("htmlparser")
View
3 src/scripts/punchfork.coffee
@@ -1,7 +1,6 @@
# Grab a Punchform recipe - http://punchfork.com/api
#
-# Punchfork - Instantly browse the best new recipes from top food sites in one place.
-# cook <ingredent> - Suggest recipe based on ingredent
+# hubot cook <ingredent> - Suggest recipe based on ingredent
#
module.exports = (robot) ->
robot.respond /cook (.*)$/i, (msg) ->
View
4 src/scripts/pypi.coffee
@@ -2,8 +2,8 @@
#
# Set HUBOT_PYPI_URL to custom PyPI server if you like. Defaults to http://pypi.python.org/pypi.
#
-# show latest from pypi for <package> - Shows latest version of Python package registered at PyPI
-# show total downloads from pypi for <package> - Shows total number of downloads accross all versions of Python package registered at PyPI
+# hubot show latest from pypi for <package> - Shows latest version of Python package registered at PyPI
+# hubot show total downloads from pypi for <package> - Shows total number of downloads accross all versions of Python package registered at PyPI
pypi = require "pypi"
View
6 src/scripts/quote.coffee
@@ -1,8 +1,8 @@
# Display a random quote or one from a specific person
#
-# enlighten - random quote
-# quote - random quote
-# quote from <person>
+# hubot enlighten - random quote
+# hubot quote - random quote
+# hubot quote from <person>
#
# Optionally set HUBOT_QUOTE_MAX_LINES to limit how long a quote
# is. Default is 4
View
2 src/scripts/rageface.coffee
@@ -1,6 +1,6 @@
# Rage face script
#
-# rage (tag) - Send a rageface for a given tag, if no tag is given, one will be chosen at random
+# hubot rage <tag> - Send a rageface for a given tag, if no tag is given, one will be chosen at random
#
Array::shuffle = -> @sort -> 0.5 - Math.random()
View
4 src/scripts/rally.coffee
@@ -1,6 +1,6 @@
# Rally information for bugs, stories, and users
#
-# rally me <defect id | task id | story id> - Lookup a task, story or defect from Rally
+# hubot rally me <defect id | task id | story id> - Lookup a task, story or defect from Rally
#
# ENV Variables Required:
# HUBOT_RALLY_USERNAME : username that hubot will use to login to Rally
@@ -123,4 +123,4 @@ prettifyDescription = (html_description, cb) ->
if !error
return_text = stdout
cb return_text
-
+
View
2 src/scripts/reddit-jokes.coffee
@@ -1,4 +1,4 @@
-# joke me - Pull a random joke from /r/jokes
+# hubot joke me - Pull a random joke from /r/jokes
module.exports = (robot) ->
View
4 src/scripts/reddit-random-top.coffee
@@ -1,4 +1,4 @@
-# a reddit <subreddit> - A random top (today) post from the specified subreddit. Tries to find a picture if possible.
+# hubot a reddit <subreddit> - A random top (today) post from the specified subreddit. Tries to find a picture if possible.
module.exports = (robot) ->
robot.respond /a reddit( .+)*/i, (msg) ->
reddit msg, msg.match[1]?.trim()
@@ -43,4 +43,4 @@ reddit = (msg, subreddit) ->
getPost = (posts) ->
random = Math.round(Math.random() * posts.data.children.length)
- posts.data.children[random]?.data
+ posts.data.children[random]?.data
View
2 src/scripts/reddit.coffee
@@ -1,4 +1,4 @@
-# reddit (me) <reddit> [limit] - Lookup reddit topic
+# hubot reddit (me) <reddit> [limit] - Lookup reddit topic
# Topic lookup from reddit
# Enrique Vidal - enrique@cloverinteractive.com
View
16 src/scripts/redmine.coffee
@@ -1,11 +1,11 @@
-# (redmine|show) me <issue-id> - Show the issue status
-# show (my|user's) issues - Show your issues or another user's issues
-# assign <issue-id> to <user-first-name> ["notes"] - Assign the issue to the user (searches login or firstname)
-# *With optional notes
-# update <issue-id> with "<note>" - Adds a note to the issue
-# add <hours> hours to <issue-id> ["comments"] - Adds hours to the issue with the optional comments
-# link me <issue-id> - Returns a link to the redmine issue
-# set <issue-id> to <int>% ["comments"] - Updates an issue and sets the percent done
+# hubot (redmine|show) me <issue-id> - Show the issue status
+# hubot show (my|user's) issues - Show your issues or another user's issues
+# hubot assign <issue-id> to <user-first-name> ["notes"] - Assign the issue to the user (searches login or firstname)
+# hubot *With optional notes
+# hubot update <issue-id> with "<note>" - Adds a note to the issue
+# hubot add <hours> hours to <issue-id> ["comments"] - Adds hours to the issue with the optional comments
+# hubot link me <issue-id> - Returns a link to the redmine issue
+# hubot set <issue-id> to <int>% ["comments"] - Updates an issue and sets the percent done
#
#
# Note: <issue-id> can be formatted in the following ways:
View
4 src/scripts/remind.coffee
@@ -1,8 +1,6 @@
# Forgetful? Add reminders.
#
-# remind me in <time> to <action> - Set a reminder in <time> to do an <action>
-# <time> is in the format 1 day, 2 hours, 5 minutes etc
-# Time segments are optional, as are commas
+# hubot remind me in <time> to <action> - Set a reminder in <time> to do an <action> <time> is in the format 1 day, 2 hours, 5 minutes etc. Time segments are optional, as are commas
class Reminders
constructor: (@robot) ->
View
2 src/scripts/resque.coffee
@@ -1,6 +1,6 @@
# Shows the status of resque queues
#
-# resque - Lists the queues with pending jobs
+# hubot resque - Lists the queues with pending jobs
module.exports = (robot) ->
url = process.env.RESQUE_WEB_URL || 'http://localhost:5678'
View
6 src/scripts/roll.coffee
@@ -1,8 +1,8 @@
# Roll a dice!
#
-# roll - Generates a random number between 1 and 100 inclusive
-# roll <num> - Generates a random number between 1 and <num> inclusive
-# roll <num>-<num2> - Generates a random number between <num> and <num2> inclusive
+# hubot roll - Generates a random number between 1 and 100 inclusive
+# hubot roll <num> - Generates a random number between 1 and <num> inclusive
+# hubot roll <num>-<num2> - Generates a random number between <num> and <num2> inclusive
#
# Examples
#
View
16 src/scripts/rollout.coffee
@@ -4,14 +4,14 @@
#
# Get rollout_rest_api here: https://github.com/jamesgolick/rollout_rest_api
#
-# rollout list - Returns a list of available features.
-# rollout show <feature> - Shows the current rollout of `feature`.
-# rollout activate_user <feature> <user_id> - Activate `feature` for `user_id`.
-# rollout deactivate_user <feature> <user_id> - Deactivate `feature` for `user_id`.
-# rollout activate_group <feature> <group> - Activate `feature` for `group_id`.
-# rollout deactivate_group <feature> <group> - Deactivate `feature` for `group_id`.
-# rollout activate_percentage <feature> <percentage> - Activate `feature` for `percentage`% of users.
-# rollout deactivate <feature> - Deactivate `feature` all users.
+# hubot rollout list - Returns a list of available features.
+# hubot rollout show <feature> - Shows the current rollout of `feature`.
+# hubot rollout activate_user <feature> <user_id> - Activate `feature` for `user_id`.
+# hubot rollout deactivate_user <feature> <user_id> - Deactivate `feature` for `user_id`.
+# hubot rollout activate_group <feature> <group> - Activate `feature` for `group_id`.
+# hubot rollout deactivate_group <feature> <group> - Deactivate `feature` for `group_id`.
+# hubot rollout activate_percentage <feature> <percentage> - Activate `feature` for `percentage`% of users.
+# hubot rollout deactivate <feature> - Deactivate `feature` all users.
endpoint = process.env.HUBOT_ROLLOUT_API_URL + '/'
View
4 src/scripts/rotten.coffee
@@ -3,8 +3,8 @@
# rotten me <movie>
#
# Examples:
-# rotten me inception
-# rotten me the good, the bad, and the ugly
+# hubot rotten me inception
+# hubot rotten me the good, the bad, and the ugly
module.exports = (robot) ->
robot.respond /rotten me (.*)$/i, (msg) ->
api_key = process.env.HUBOT_ROTTEN_TOMATOES_API_KEY
View
4 src/scripts/rsstodolist.coffee
@@ -2,8 +2,8 @@
#
# http://rsstodolist.appspot.com/
#
-# rtdl show <user_name> - Display the <user_name> RssToDoList feed url
-# rtdl add <user_name> <link> - Send the <link> to <user_name> RssToDoList feed
+# hubot rtdl show <user_name> - Display the <user_name> RssToDoList feed url
+# hubot rtdl add <user_name> <link> - Send the <link> to <user_name> RssToDoList feed
#
module.exports = (robot) ->
View
2 src/scripts/ruby.coffee
@@ -1,6 +1,6 @@
# Evaluate one line of Ruby script.
#
-# ruby|rb <script> - Evaluate one line of Ruby script
+# hubot ruby|rb <script> - Evaluate one line of Ruby script
module.exports = (robot) ->
robot.respond /(ruby|rb)\s+(.*)/i, (msg)->
script = msg.match[2]
View
2 src/scripts/rubygems.coffee
@@ -1,6 +1,6 @@
# Find a rubygem from rubygems.org
#
-# <there's a gem for> that - Returns a link to a gem on rubygems.org
+# hubot there's a gem for <that> - Returns a link to a gem on rubygems.org
#
module.exports = (robot) ->