Class Pyre::Campfire
In: lib/pyre/campfire.rb
Parent: Object

Pyre::Campfire is for general Campfire tasks. Logging in, logging out, and finding rooms.

Methods

find_room_by_id   find_room_by_name   logged_in?   login   logout   new   room   rooms  

Attributes

agent  [R] 
subdomain  [R] 
uri  [R] 

Public Class methods

new(subdomain, options={}) {|self| ...}

Create a new Pyre::Campfire object. Pass in your subdomain and maybe some options. Of course, the only option is whether or not to use ssl. Pass along :ssl => true if you need it. Give it a block for self-contained wonderfulness (logs out for you).

Public Instance methods

find_room_by_id(id)

Know the id of the room you‘re looking for? Try it here.

find_room_by_name(name)

Know the name of the room you‘re looking for? Try it here.

login(email, password)

Login with the supplied credentials. Returns true on success.

logout()

Log out. Returns true on success.

room(identifier) {|room| ...}

Pass the name or id of the room and get it back. Pass a block too! If you pass a block, the room will be left when the block completes.

rooms()

Get a list of all the rooms as Pyre::Room objects.

[Validate]