dane / hipchat Goto Github PK

A golang package to communicate with HipChat over XMPP

License: BSD 3-Clause "New" or "Revised" License

Go 100.00%

hipchat's Introduction

hipchat

This is a abstraction in golang to Hipchat's implementation of XMPP. It communicates over TLS and requires zero knowledge of XML or the XMPP protocol.

Examples available here
Documentation available here

bot building

Hipchat treats the "bot" resource differently from any other resource connected to their service. When connecting to Hipchat with a resource of "bot", a chat history will not be sent. Any other resource will receive a chat history.

example/hello.go

package main

import (
	"github.com/daneharrigan/hipchat"
)

func main() {
	user := "11111_22222"
	pass := "secret"
	resource := "bot"
	roomJid := "[email protected]"
	fullName := "Some Bot"

	client, err := hipchat.NewClient(user, pass, resource)
	if err != nil {
		fmt.Printf("client error: %s\n", err)
		return
	}

	client.Status("chat")
	client.Join(roomJid, fullName)
	client.Say(roomJid, fullName, "Hello")
	select {}
}

hipchat's People

Contributors

Stargazers

Watchers

hipchat's Issues

Cannot filter out old messages when joining a room

Upon joining a room, HipChat sends a dump of the room's recent history, which I want to filter out. This library does not expose any timestamp data (which I assume hipchat provides for these history messages). And I can't seem to connect as a bot by joining rooms with a JID of "bot" as per this support page.

License

What license is this code released under? I would like to fork it and adapt it for a different xmpp server.

Client JID domain != host when using Hipchat Server

When using Hipchat Server (on-prem Hipchat) the client domain is not the same as the hostname of the server. Currently this client assumes a JID of user@host.

Example scenario with Hipchat Server:

Hostname: hipchat.example.com
Username: 1_1
Client JID: [email protected]
MUC domain: conf.btf.hipchat.com

(Note the ".btf" bit which is also different from 'normal' Hipchat.)

This breaks things like requesting the roster etc.

Receiving unsolicited xmpp.NsDisco or xmpp.NsIqRoster will block listen function

This problem can be reproduced by connecting to hipchat and changing the name of a user.

The receivedRooms and receivedUsers channels are unbuffered, so sending data to this channel will block until something receives from this channel. The only time these channels are received from are in the Users() and Rooms() methods.

However, these messages generate a request so would still leave the listen thread blocked. We exposed the channels and used a goroutine similar to this to avoid the endless block. Note: Rooms() and Users() in this example just return the channels and don't make requests (the same as Messages()).

go func() {
    for {
        select {
        case message := <-client.Messages():
            log.Printf("Received message: %v", message)
        case rooms := <-client.Rooms():
            log.Printf("Received rooms: %v", rooms)
        case users := <-client.Users():
            log.Printf("Received users: %v", users)
        }
    }
}()

Obviously there still needs to be work done to communicate received rooms and users to other goroutines, but this is one way to avoid the problem.

Timeout after nickname change

While in the reply example you are listening to the incoming messages and someone changes his nickname via the web interface the connection will time out and the bot will shortly disconnect.

It only happens in this scenario.

Support HipChat 2.0.0 build 2.0.7

It seems that the XMPP interface at port 5222/5223 will be closed with newer HipChat server versions.
Is der any idea how to support this change?

https://confluence.atlassian.com/hc/hipchat-server-release-notes-608731400.html

does it handles reconnections?

If not, how can I do it?

Certificate issue

Hi,
i'm trying to use your library to connect to a self hosted hipchat instance and facing a problem with the TLS connection.
I'm everytime getting the following error:
client error: x509: certificate has expired or is not yet valid
So it seems that the certificate is expired but I want to connect anyway. So how can I disable the Cert verify?
Thanks