foca / tinder forked from collectiveidea/tinder

Tinder is an Ruby API for interfacing with Campfire, the 37Signals chat application.

This URL has Read+Write access

tinder / README.txt
100644 44 lines (27 sloc) 1.323 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
= Tinder - get the Campfire started
 
Tinder is a library for interfacing with Campfire, the chat application from 37Signals. Unlike Marshmallow, it is designed to be a full-featured API (since 37Signals doesn't provide a real one), allowing you to programatically manage and speak/listen in chat rooms.
 
== Usage
 
  campfire = Campfire.new 'mysubdomain'
  campfire.login 'myemail@example.com', 'mypassword'
 
  room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
  room.rename 'New Room Name'
  room.speak 'Hello world!'
  room.paste "my pasted\ncode"
  room.destroy
 
  room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
  room.speak 'Hello world!'
  
  See the RDoc for more details.
 
== Requirements
 
* Active Support
  gem install activesupport
* Hpricot
  gem install hpricot
  
== Installation
 
Tinder can be installed as a gem or a Rails plugin:
 
  gem install tinder
  
  script/plugin install http://source.collectiveidea.com/public/tinder/trunk
  
== Development
 
The source for Tinder is available at http://source.collectiveidea.com/public/tinder/trunk. Development can be followed at http://opensoul.org/tags/tinder. Contributions are welcome!
 
== ToDo
 
* Tests! (unit and remote)
* Marshmallow-style integration scripts for exception notification and continuous integration