App::KGB::API -- KGB bot API documentation
Version 4 uses JSON-RPC as described in http://http://json-rpc.org/wiki/specification with one extension. Since all requests are authenticated, two HTTP headers need to be included:
The project name is the string identifying the project on the server side, and the hash is the hexadecimal representation of the SHA-1 hash calculated over the following data:
This is the shared password known to the client and the server.
This is the JSON-encoded request text. The same that is sent in the HTTP body.
Request is a JSON-RPC call to a method called commit_v4 with a single argument, which is a map with the following possible keys:
Usually r for Subversion commits
r
Subversion revision, Git hash or just empty (for CVS).
A list of changes, encoded as strings. It is simple file name prepended with (A) for added, (M) (or nothing) for modified and (D) for deleted. See App::KGB::Change.
(A)
(M)
(D)
A map with extra information. Currently web_link is the only member that the server recognises.
web_link
The message relay calls are to the relay_message method, with the only argument the message to be relayed.
kgb-client(1), kgb-bot(1)
Copyright (C) 2012 Damyan Ivanov
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
To install App::KGB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::KGB
CPAN shell
perl -MCPAN -e shell install App::KGB
For more information on module installation, please visit the detailed CPAN module installation guide.