https://github.com/zk/xmpp-clj
A lightweight clojure wrapper around the smack jabber/XMPP library
https://github.com/zk/xmpp-clj
Last synced: 13 days ago
JSON representation
A lightweight clojure wrapper around the smack jabber/XMPP library
- Host: GitHub
- URL: https://github.com/zk/xmpp-clj
- Owner: zk
- Created: 2010-04-02T19:23:08.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2012-11-28T04:44:19.000Z (about 13 years ago)
- Last Synced: 2025-03-24T00:42:00.952Z (9 months ago)
- Language: Clojure
- Homepage:
- Size: 299 KB
- Stars: 42
- Watchers: 6
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# xmpp-clj
xmpp-clj allows you to write simple jabber bots in idiomatic clojure by providing a lightweight wrapper around the [smack](http://www.igniterealtime.org/projects/smack/) library.
## Lein
[xmpp-clj "0.3.1"]
## Usage
Create a temporary jabber account for your bot. I've used gmail here, but there are a bunch of free providers
Create a leiningen project and cd into the project directory
lein new mybot
cd ./mybot
Add xmpp-clj to your deps (project.clj):
(defproject mybot "0.1.0"
:description "FIXME: write"
:dependencies [[xmpp-clj "0.3.1"]])
Open up src/mybot/core.clj and require the xmpp lib:
(ns mybot.core
(:require [xmpp-clj :as xmpp]))
Define a handler and start the bot. Handlers accept a single parameter
-- the message map -- and should return a string with a message back
to the sender. Return `nil` to omit a response. Here's a very simple
example:
;; This bot always responds with the message 'Ermahgerd!!!'
(xmpp/start-bot :username "testclojurebot@gmail.com"
:password "clojurebot12345"
:host "talk.google.com"
:domain "gmail.com"
:handler (fn [m] "Ermahgerd!!!")
Next, fire up your chat client, add your new bot buddy, and send him /
her a message. The response should look someting like this:
> me: hello chatbot
> chatbot: Ermahgerd!!!
;; Stop the bot when you're done:
(xmpp/stop-bot)
;; You can use a name to start / stop multiple bots in the same
;; process:
(xmpp/start-bot :name :bot1
:username ...)
(xmpp/start-bot :name :bot2
:username ...)
(xmpp/stop-bot :bot1)
(xmpp/stop-bot :bot2)
;; And names can be any value / object:
(xmpp/start-bot :name 0
:username ...)
(xmpp/start-bot :name 1
:username ...)
See the `src/xmpp_clj/examples` folder for additional examples. If
you'd like to manually manage connections, see the `xmpp-clj.bot`
namespace.
## Problems?
Open up an [issue](http://github.com/zkim/xmpp-clj/issues)
## License
[Eclipse Public License v1.0](http://www.eclipse.org/legal/epl-v10.html)