| 1 | package Hubot; | ||
| 2 | $Hubot::VERSION = '0.2.8'; | ||
| 3 | 1; | ||
| 4 | |||
| 5 | =pod | ||
| 6 | |||
| 7 | =encoding utf-8 | ||
| 8 | |||
| 9 | =head1 NAME | ||
| 10 | |||
| 11 | Hubot - L<AnyEvent> based L<https://github.com/github/hubot> | ||
| 12 | |||
| 13 | =head1 VERSION | ||
| 14 | |||
| 15 | version 0.2.8 | ||
| 16 | |||
| 17 | =head1 SYNOPSIS | ||
| 18 | |||
| 19 | $ echo '["help"]' > hubot-scripts.json | ||
| 20 | $ hubot | ||
| 21 | hubot> hubot help | ||
| 22 | hubot> exit | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | =head2 CONFIGURATION | ||
| 27 | |||
| 28 | describe scripts name to F<hubot-scripts.json> | ||
| 29 | |||
| 30 | example) | ||
| 31 | |||
| 32 | [ | ||
| 33 | "help", | ||
| 34 | "shorten", | ||
| 35 | "ascii" | ||
| 36 | ] | ||
| 37 | |||
| 38 | each scripts has each congiruation rules. | ||
| 39 | |||
| 40 | check it out C<perldoc Hubot::Scripts::E<lt>scriptE<gt>>. | ||
| 41 | |||
| 42 | described order can affect the bot's action. | ||
| 43 | if "shorten" is appear than "tweet", C<http://twitter.com/E<lt>usernameE<gt>/status/E<lt>tweetidE<gt>> processed twice by "shorten" and "tweet". | ||
| 44 | the secret is behind of `tweet` script. | ||
| 45 | actually, L<Hubot::Message> C<finish> method. | ||
| 46 | |||
| 47 | if F<hubot-scripts.json> is not exist, built-in scripts | ||
| 48 | |||
| 49 | "help", "ascii", "roles" | ||
| 50 | |||
| 51 | are loaded automatically. | ||
| 52 | |||
| 53 | =head1 ADAPTERS | ||
| 54 | |||
| 55 | choose the adapter at runtime. | ||
| 56 | |||
| 57 | adapters are sharing all `Hubot::Scripts::*` extends scripts. | ||
| 58 | |||
| 59 | $ hubot -a <adapter> | ||
| 60 | |||
| 61 | =head2 BUNDLE ADAPTERS | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item L<Hubot::Adapter::Shell> | ||
| 66 | |||
| 67 | gives local shell prompt. | ||
| 68 | good choice for development. | ||
| 69 | |||
| 70 | =item L<Hubot::Adapter::Irc> | ||
| 71 | |||
| 72 | =item L<Hubot::Adapter::Campfire> | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | =head2 BUNDLE SCRIPTS | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item L<Hubot::Scripts::help> | ||
| 81 | |||
| 82 | hubot: help | ||
| 83 | |||
| 84 | =item L<Hubot::Scripts::ascii> | ||
| 85 | |||
| 86 | ascii hello | ||
| 87 | |||
| 88 | =item L<Hubot::Scripts::shorten> | ||
| 89 | |||
| 90 | http://example.com | ||
| 91 | |||
| 92 | =item L<Hubot::Scripts::tweet> | ||
| 93 | |||
| 94 | http://twitter.com/KBO_Scores/status/256376098764505088 | ||
| 95 | |||
| 96 | =item L<Hubot::Scripts::roles> | ||
| 97 | |||
| 98 | hubot: <user> is a <role> | ||
| 99 | hubot: who is <user> | ||
| 100 | hubot: <user> is not a <role> | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item L<https://github.com/github/hubot> | ||
| 109 | |||
| 110 | =item L<https://github.com/github/hubot-scripts> | ||
| 111 | |||
| 112 | =item L<Hubot::Robot> | ||
| 113 | |||
| 114 | =item L<Hubot::Adapter> | ||
| 115 | |||
| 116 | =item L<Hubot::Brain> | ||
| 117 | |||
| 118 | =item L<Hubot::Listener> | ||
| 119 | |||
| 120 | =item L<Hubot::Message> | ||
| 121 | |||
| 122 | =item L<Hubot::Response> | ||
| 123 | |||
| 124 | =item L<Hubot::User> | ||
| 125 | |||
| 126 | =back | ||
| 127 | |||
| 128 | =head1 AUTHOR | ||
| 129 | |||
| 130 | Hyungsuk Hong <hshong@perl.kr> | ||
| 131 | |||
| 132 | =head1 COPYRIGHT AND LICENSE | ||
| 133 | |||
| 134 | This software is copyright (c) 2012 by Hyungsuk Hong. | ||
| 135 | |||
| 136 | This is free software; you can redistribute it and/or modify it under | ||
| 137 | the same terms as the Perl 5 programming language system itself. | ||
| 138 | |||
| 139 | =cut |