Raccdoc

DESCRIPTION

Raccdoc is an API into the data of several classic telnet-based BBS systems, including:

This is a Ruby version of that API.

The Raccdoc API document can be found at dev.iscabbs.com/doku.php?id=raccdoc_protocol_documentation

EXAMPLE

require 'raccdoc'

# Connect to the BBS as user Bugcrusher
bbs = Raccdoc::Connection.new(:host => 'bbs.iscabbs.com', :port => 6145, :user => 'Bugcrusher', :password => 'MyPass')

# Find out information on each forum
bbs.forums.each do |id, data|
  print "On forum number #{id} named #{data[:name]}\n"
end

# Join the Babble forum
forum = bbs.jump("Babble")

# See if you have permission to post
print "Can you post in there? #{forum.post?}\n"

# Read post number 2280
post = forum.read(2280)

# Print out the post body for 2280
print "Body is #{post.body}\n"

# Make your own post
mypost = forum.post("Hello world!")

# Get information on it
print "My new post is id number #{mypost.id}\n"

# Now delete it
mypost.delete

# Log out
bbs.logout

REQUIREMENTS

  • Ruby 1.8

  • An account on the BBS that you wish to access (unless doing Guest/read-only operations)

  • Mocha (for tests)

TODO & KNOWN ISSUES

  • X-Message support

  • Mail> support

INSTALL

Then require ‘raccdoc’ in your Ruby program.

LICENSE

(The MIT License)

Copyright © 2009 H. Wade Minter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.