raccdoc 0.0.10

data/.gitignore

@@ -0,0 +1,5 @@
+tmp/
+coverage/
+doc/
+pkg/
+*.gem

data/CHANGELOG

@@ -0,0 +1 @@
+For changes, see the github source at http://github.com/minter/raccdoc/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 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.

data/Manifest

@@ -0,0 +1,14 @@
+CHANGELOG
+lib/raccdoc/connection.rb
+lib/raccdoc/forum.rb
+lib/raccdoc/post.rb
+lib/raccdoc.rb
+LICENSE
+Manifest
+raccdoc.gemspec
+Rakefile
+README.rdoc
+test/raccdoc_connection_test.rb
+test/raccdoc_forum_test.rb
+test/raccdoc_post_test.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,92 @@
+= Raccdoc
+  
+== DESCRIPTION
+
+Raccdoc is an API into the data of several classic telnet-based BBS systems, including:
+
+* ISCABBS[http://iscabbs.com/]
+* InaraBBS[http://www.inarabbs.com/]
+* Gestalt
+ 
+This is a Ruby version of that API.
+
+The Raccdoc API document can be found at http://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
+
+* gem sources -a http://gems.rubyforge.org/
+* sudo gem install raccdoc
+
+Then require 'raccdoc' in your Ruby program.
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 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. 

data/Rakefile

@@ -0,0 +1,32 @@
+require './lib/raccdoc.rb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "raccdoc"
+    gemspec.summary = "Ruby interface into the Raccdoc BBS API"
+    gemspec.description = "A Ruby way to speak the Raccdoc protocol"
+    gemspec.email = "minter@lunenburg.org"
+    gemspec.homepage = "http://github.com/minter/raccdoc"
+    gemspec.authors = ["H. Wade Minter"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+namespace :test do
+  desc 'Check test coverage'
+  task :coverage do
+    rm_f "coverage"
+    system("rcov -x '/Library/Ruby/Gems/1.8/gems/' --sort coverage #{File.join(File.dirname(__FILE__), 'test/*_test.rb')}")
+    system("open #{File.join(File.dirname(__FILE__), 'coverage/index.html')}") if PLATFORM['darwin']
+  end
+    
+  desc 'Remove coverage products'
+  task :clobber_coverage do
+    rm_r 'coverage' rescue nil
+  end
+  
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.10

data/lib/raccdoc.rb

@@ -0,0 +1,21 @@
+module Raccdoc
+  
+  VERSION = '0.0.10'
+  require 'socket'
+  require 'time'
+  
+  $:.unshift(File.dirname(__FILE__))
+  require 'raccdoc/connection'
+  require 'raccdoc/forum'
+  require 'raccdoc/post'
+
+end
+
+class InvalidLogin < StandardError
+end
+
+class ConnectionError < StandardError
+end
+
+class ResponseError < StandardError
+end

data/lib/raccdoc/connection.rb

@@ -0,0 +1,108 @@
+module Raccdoc
+  class Connection
+
+    attr_reader :host
+    attr_reader :post
+
+    # Creates a new Raccdoc connection.  By default, it connects to bbs.iscabbs.com, port 6145, which is the
+    # ISCABBS server.
+    #
+    # If a :user and :password is not supplied, a guest/anonymous login is done.  Most, if not all, posting is
+    # restricted under this account.  
+    #
+    # If the TCP connection fails, or the login is rejected, and exception is raised.
+    def initialize(param_args = {:host => 'bbs.iscabbs.com', :port => '6145', :user => nil, :password => nil})
+      args = {:host => 'bbs.iscabbs.com', :port => '6145', :user => nil, :password => nil }
+
+      args.merge!(param_args)
+      begin
+        @socket = TCPSocket.new(args[:host],args[:port])
+      rescue Errno::ECONNREFUSED
+        raise ConnectionError, "Could not connect to #{args[:host]}, port #{args[:port]}\n"
+      end
+
+      begin
+        response = @socket.readline.chomp
+      rescue EOFError
+        raise ConnectionError, "Got an unexpected EOF from the remote end"
+      end
+      
+      unless response.match(/^2/)
+        raise ConnectionError, response
+      end
+
+      if (args[:user] && args[:password])
+        @socket.puts("LOGIN #{args[:user]}\t#{args[:password]}")
+        response = @socket.readline.chomp
+        unless response.match(/^2/)
+          raise InvalidLogin, response
+        end
+      end
+      @host = args[:host]
+      @port = args[:port]
+    end
+
+    # Closes the Raccdoc connection, then closes the socket.
+    def logout
+      unless @socket.closed?
+        @socket.puts "QUIT" 
+
+        response = @socket.readline.chomp
+        unless response.match(/^2/)
+          raise ConnectionError, response
+        end
+        @socket.close
+      end
+      return true
+    end
+
+    # Tests the TCP socket to make sure that it's still connected to the remote server.
+    def connected?
+      @socket.closed? ? false : true
+    end
+
+    # Sets the active forum on the server to the specified forum name or ID, and returns a new Raccdoc::Forum object.
+    #
+    # The forum can be specified by number (0), or name ("Lobby" or "Program")
+    def jump(forum = 0)
+      Raccdoc::Forum.new(@socket, forum.to_s)
+    end
+
+    # Returns a hash of forum information.  The key is the forum ID number, and the value is a hash containing the following data:
+    #
+    # * name - The forum name
+    # * lastnote - The earliest post ID number in the forum
+    # * admin - The handle of the forum admin
+    #
+    # The argument can be one of: ALL (default), PUBLIC, PRIVATE, TODO, JOINED, NAMED, THREADS
+    # depending on server support
+    #
+    # Note that this does not return actual Raccdoc::Forum objects in the interest of saving resources, so you'll need to jump to the forum that you want.
+    def forums(type="all")
+      @socket.puts "LIST #{type}"
+      forums = Hash.new
+
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise ResponseError, response
+      end
+
+      while line = @socket.readline.chomp
+        break if line.match(/^\.$/)
+        tmp = Hash.new
+        line.split(/\t/).each do |pair|
+          (key, value) = pair.split(/:/)
+          if key == "admin"
+            value = value.split('/')[1]
+          end
+          tmp[key.to_sym] = value
+        end
+        id = tmp[:topic].to_i
+        forums[id] = tmp
+      end
+
+      return forums
+    end
+
+  end
+end

data/lib/raccdoc/forum.rb

@@ -0,0 +1,204 @@
+module Raccdoc
+  class Forum
+
+    attr_reader :id
+    attr_reader :name
+    attr_reader :admin
+    attr_reader :anonymous
+    attr_reader :private
+
+    # Sets the active forum on the server to the specified forum number (0) or name (Lobby, Program), then returns a new Raccdoc::Forum object.
+    #
+    # There are five instance variables exposed through attr_reader:
+    #
+    # * id - The forum ID number
+    # * name - The forum name
+    # * admin - The name of the forum administrator
+    # * anonymous - either true, false, or force, depending on whether the anonymous posting option is on, off, or required
+    # * private - True if the forum is private (invite-only), false otherwise
+    def initialize(socket, forum = 0)
+      @socket = socket
+      @socket.puts "TOPIC #{forum.to_s}"
+      response = @socket.readline.chomp
+      unless response.match(/^2/)
+        raise ResponseError, response
+      end
+
+      @headers = {}
+      tuples = response.split(/\t/)
+      tuples.delete_at(0)
+      tuples.each do |pair|
+        (key, value) = pair.split(/:/)
+        @headers[key.downcase.to_sym] = value
+      end
+
+      flags = @headers[:flags].split(',')
+
+      if flags.include?("forceanonymous")
+        @anonymous = "force"
+      elsif flags.include?("cananonymous")
+        @anonymous = true
+      else
+        @anonymous = false
+      end
+
+      @private = flags.include?("private") ? true : false
+
+      @id = @headers[:topic]
+      @name = @headers[:name]
+      @admin = @headers[:admin].split('/')[1]
+    end
+
+    # Returns an array of all current post IDs in the forum.
+    #
+    # Takes an optional range string of the form oldest_noteid-newest_noteid.  The oldest or newest can be omitted as needed.
+    def noteids(range = "")
+      noteids = Array.new
+      @socket.puts("XHDR noteno #{range.to_s}")
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise ResponseError, response
+      end
+
+      while line = @socket.readline.chomp
+        break if line.match(/^\.$/)
+        (tag,noteid) = line.split(/:/)
+        noteids.push(noteid.to_i)
+      end
+
+      return noteids
+    end
+
+    # Returns a hash of the forum information.  Keys are:
+    #
+    # * from - The username of the user who last updated the FI
+    # * date - The date the forum information was last updated (a Time object)
+    # * body - The actual text of the FI
+    def forum_information
+      fi = Hash.new
+      @socket.puts("SHOW info")
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise ResponseError, response
+      end
+
+      # Get header information
+      while line = @socket.readline.chomp
+        break if line.match(/^$/)
+        (key, value) = line.split(/: /)
+        if key.downcase == "date"
+          value = Time.parse(value)
+        end
+        fi[key.downcase.to_sym] = value
+      end
+
+      body = ""
+      while line = @socket.readline
+        break if line.match(/^\.$/)
+        body << line
+      end
+      fi[:body] = body
+
+      return fi
+    end
+
+    # Sets the current user's first-unread pointer to the specified number.  Any posts greater than that number will be listed as unread.
+    def first_unread=(postid = 0)
+      @socket.puts("SETRC #{postid.to_s}")
+      response = @socket.readline.chomp
+      unless response.match(/^2/)
+        raise ResponseError, response
+      end
+    end
+
+    # Returns the post ID number of the last read post in the forum.  Any posts greater than that number can be considered unread.
+    def first_unread
+      @socket.puts("SHOW rcval")
+      response = @socket.readline.chomp
+      unless response.match(/^2/)
+        raise ResponseError, response
+      end
+      response.match(/\d+.*?:\s+(\d+)/)
+      return $1
+    end
+
+    # Returns a hash of information about the posts in the forum.  The hash is keyed off of the post ID, and the value is a hash containing the following information:
+    #
+    # * author - The username of the user who created the post
+    # * date - The date the post was created or, if the post is anonymous, the current date in UTC
+    # * subject - The first line of the post
+    # * size - The size of the post in bytes
+    # * authority - If the post was made with Sysop or Forum Manager status, this is set    
+    # 
+    # You may provide an optional range (in the form "start_id-end_id") to limit the number of posts returned.  The default is to return all posts in the forum.
+    def post_headers(range = "")
+      @socket.puts("XHDR ALL #{range.to_s}")
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise ResponseError, response
+      end
+
+      posts = Hash.new
+
+      while (line = @socket.readline.chomp)
+        break if line.match(/^\.$/)
+        tmpdata = Hash.new
+        line.split(/\t/).each do |tuple|
+          (key, value) = tuple.split(/:/, 2)
+          tmpdata[key.downcase.to_sym] = value 
+        end
+        tmpdata[:date] = tmpdata[:date] ? Time.parse(tmpdata[:date]) : Time.new.getgm
+        tmpdata[:author] = tmpdata[:"formal-author"] ? tmpdata[:"formal-author"].split('/')[1] : 'Anonymous'
+        posts[tmpdata[:noteno]] = tmpdata
+      end
+      return posts
+    end
+
+    # Returns a new Raccdoc::Post object for the specified post ID in the current forum.
+    def read(postid)
+      Post.new(@socket,postid)
+    end
+
+    # Attempts to do a "DAMMIT" read, overriding anonymous and deleted flags.  If you do not have permission to bypass those flags, this is equivalent to a plain read.
+    def read!(postid)
+      Post.new(@socket,postid,:dammit => true)
+    end
+
+    # Creates a new post in the current forum using the text provided in the argument.  
+    #
+    # Returns a new Raccdoc::Post object that results from reading the newly created post.
+    def post(body)
+      @socket.puts("POST")
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise ResponseError, response
+      end
+
+      @socket.puts(body)
+      @socket.puts(".")
+
+      response = @socket.readline.chomp
+      if response.match(/^2/)
+        postid = response.split(/:\s+/)[1]
+        return Post.new(@socket,postid)
+      else
+        raise ResponseError, response
+      end
+    end
+
+    # Checks to see if the currently logged in user has permission to post in the current forum.  
+    #
+    # Returns true or false.
+    def post?
+      @socket.puts("OKAY POST")
+      response = @socket.readline.chomp
+      if response.match(/^2/)
+        return true
+      elsif response.match(/^4/)
+        return false
+      else
+        raise ResponseError, response
+      end
+    end
+  end
+end

data/lib/raccdoc/post.rb

@@ -0,0 +1,83 @@
+module Raccdoc
+  class Post
+
+    attr_reader :id
+    attr_reader :date
+    attr_reader :author
+    attr_reader :body
+    attr_reader :authority
+
+    # Creates a new Raccdoc::Post object by reading the specified post.  If no post is given, it returns the first unread post, if any.
+    #
+    # Useful information returned:
+    #
+    # * id - The numerical post ID
+    # * date - The date the post was made (or the current date in UTC if the post is anonymous)
+    # * author - The username of the user that created the post
+    # * body - The textual body of the post.
+    # * authority - either "Sysop" or "Forum Moderator" if the post was made with that header.
+    def initialize(socket,postid,args={})
+      @socket = socket
+      dammit = args[:dammit] ? 'DAMMIT' : ''
+      @socket.puts "READ #{postid.to_s} #{dammit}"
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise ResponseError, response
+      end
+
+      # Get header information
+      post = Hash.new
+
+      while line = @socket.readline.chomp
+        break if line.match(/^$/)
+        (key,value) = line.split(/: /)
+        post[key.downcase.to_sym] = value
+      end
+      post[:id] = postid
+      post[:date] = post[:date] ? Time.parse(post[:date]) : Time.new.getgm
+
+      post[:body] = ""
+      while (line = @socket.readline)
+        break if line.match(/^\.$/)
+        post[:body] << line
+      end
+
+      @id = post[:id]
+      @date = post[:date]
+      @author = post[:from]
+      @body = post[:body]
+      @authority = post[:authority]
+      return post
+    end
+
+    # Checks to see if the currently-logged-in user has permission to delete the current post.  
+    #
+    # Returns true or false
+    def delete?
+      @socket.puts("OKAY DELETE NOTE #{self.id}")
+      response = @socket.readline.chomp
+      if response.match(/^2/)
+        return true
+      elsif response.match(/^4/)
+        return false
+      else
+        raise ResponseError, response
+      end
+    end
+
+    # Attempts to delete the current post.  
+    #
+    # Returns true or false
+    def delete
+      @socket.puts("DELETE NOTE #{self.id}")
+      response = @socket.readline.chomp
+      if response.match(/^2/)
+        return true
+      elsif response.match(/^4/)
+        return false
+      else 
+        raise ResponseError, response
+      end
+    end
+  end
+end

data/raccdoc.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{raccdoc}
+  s.version = "0.0.10"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["H. Wade Minter"]
+  s.date = %q{2009-10-08}
+  s.description = %q{A Ruby way to speak the Raccdoc protocol}
+  s.email = %q{minter@lunenburg.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/raccdoc.rb",
+     "lib/raccdoc/connection.rb",
+     "lib/raccdoc/forum.rb",
+     "lib/raccdoc/post.rb",
+     "raccdoc.gemspec",
+     "test/raccdoc_connection_test.rb",
+     "test/raccdoc_forum_test.rb",
+     "test/raccdoc_post_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/minter/raccdoc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby interface into the Raccdoc BBS API}
+  s.test_files = [
+    "test/raccdoc_connection_test.rb",
+     "test/raccdoc_forum_test.rb",
+     "test/raccdoc_post_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/raccdoc_connection_test.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class RaccdocConnectionTest < Test::Unit::TestCase
+  def setup
+    @socket = mock()
+    @socket.stubs(:puts)
+    @socket.expects(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==")
+    TCPSocket.expects(:new).returns(@socket)
+    @bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
+  end
+  
+  def test_valid_anonymous_connection
+    assert_equal @bbs.class, Raccdoc::Connection
+    assert_equal @bbs.host, "test.bbs.example"
+  end
+  
+  def test_connection_refused_anonymous
+    TCPSocket.expects(:new).with('test.bbs.example', '6145').raises(Errno::ECONNREFUSED)
+    assert_raise(ConnectionError, 'Could not connect to test.bbs.example, port 6145') do
+      bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
+    end
+  end
+  
+  def test_connection_bad_login
+    socket = mock()
+    socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==").then.returns("405 Cannot process login 	Invalid password")
+    socket.stubs(:puts)
+    TCPSocket.expects(:new).returns(socket)
+    assert_raise(InvalidLogin, '404 User does not exist') do
+      bbs = Raccdoc::Connection.new(:host => 'test.bbs.example', :user => 'Bugcrusher', :password => 'BadPassword')
+    end
+  end
+  
+  def test_connection_that_returns_unknown_status
+    socket = mock()
+    TCPSocket.expects(:new).returns(socket)
+    socket.expects(:readline).returns("999 Stuff is messed up")
+    assert_raise(ConnectionError) do
+      bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
+    end
+  end
+  
+  def test_logout_succeeds
+    @socket.stubs(:close)
+    @socket.stubs(:closed?).returns(false)
+    @socket.stubs(:readline).returns("201 Session ended")
+    result = @bbs.logout
+    assert_equal result, true
+  end
+  
+  def test_logout_fails
+    @socket.stubs(:close)
+    @socket.stubs(:closed?).returns(false)
+    @socket.stubs(:readline).returns("999 Something Broke")
+    assert_raise(ConnectionError) do
+      @bbs.logout
+    end
+  end
+  
+  def test_connected
+    @socket.stubs(:puts)
+    @socket.stubs(:closed?).returns(false)
+    @socket.stubs(:readline).returns("999 Something Broke")
+    assert_equal @bbs.connected?, true
+  end
+  
+  def test_forums_success
+    @socket.stubs(:readline).returns("301 Topic list follows").then.returns("topic:0	name:Lobby	lastnote:2331	flags:nosubject,sparse	admin:acct578247-oldisca/Elvis/(hidden)").then.returns(".")
+    forums = @bbs.forums
+    assert_equal forums.class, Hash
+    assert_equal forums.size, 1
+    assert_equal forums[0][:name], "Lobby"
+  end
+  
+  def test_forums_failure
+    @socket.stubs(:readline).returns("999 Stuff Broke")
+    assert_raise(ResponseError) do
+      forums = @bbs.forums
+    end
+  end
+  
+  def test_jump
+    @forum = mock()
+    @forum.expects(:name).returns("Lobby")
+    Raccdoc::Forum.expects(:new).returns(@forum)
+    forum = @bbs.jump(0)
+    assert_equal forum.name, "Lobby"
+  end
+end

data/test/raccdoc_forum_test.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class RaccdocForumTest < Test::Unit::TestCase
+  def setup
+    @socket = mock()
+    @socket.stubs(:puts)
+    @socket.stubs(:readline).returns("204 Topic set to: 	topic:0	name:Lobby	lastnote:2331	flags:nosubject,sparse	admin:acct578247-oldisca/Elvis/(hidden)	firstnote:2275")
+    @forum = Raccdoc::Forum.new(@socket, 0)
+  end
+  
+  def test_creation
+    assert_equal @forum.class, Raccdoc::Forum
+    assert_equal @forum.name, "Lobby"
+    assert_equal @forum.admin, "Elvis"
+    assert_equal @forum.id, "0"
+    assert_equal @forum.anonymous, false
+    assert_equal @forum.private, false
+  end
+  
+  def test_creation_fail
+    socket = mock()
+    socket.stubs(:puts)
+    socket.stubs(:readline).returns('999 Stuff broke')
+    assert_raise(ResponseError) do
+      forum = Raccdoc::Forum.new(socket,0)
+    end
+  end
+  
+  def test_anonymous_allowed
+    socket = mock()
+    socket.stubs(:puts)
+    socket.stubs(:readline).returns("204 Topic set to: 	topic:173	name:Kama Sutra	lastnote:57263	flags:nosubject,sparse,private,cananonymous	admin:acct30177-oldisca/Kubla Khan/(hidden)	firstnote:57111")
+    forum = Raccdoc::Forum.new(socket, 173)
+    assert_equal forum.anonymous, true
+  end
+  
+  def test_anonymous_forced
+    socket = mock()
+    socket.stubs(:puts)
+    socket.stubs(:readline).returns("204 Topic set to: 	topic:7	name:Weird Soup	lastnote:864957	flags:nosubject,sparse,forceanonymous	admin:acct576222-oldisca/Weird FM/(hidden)	firstnote:864808")
+    forum = Raccdoc::Forum.new(socket,7)
+    assert_equal forum.anonymous, "force"
+  end
+  
+  def test_noteids
+    @socket.stubs(:readline).returns("306 Note headers follow").then.returns("noteno:2275").then.returns("noteno:2280").then.returns(".")
+    notes = @forum.noteids
+    assert_equal notes.class, Array
+    assert_equal notes.size, 2
+  end
+  
+  def test_noteids_failure
+    @socket.stubs(:readline).returns("999 Stuff Broke")
+    assert_raise(ResponseError) do
+      notes = @forum.noteids
+    end
+  end
+  
+  def test_forum_information
+    @socket.stubs(:readline).returns("303 Topic info follows").then.returns("From: Adonis").then.returns("Date: Fri, 30 May 2003 02:05:00 GMT").then.returns("").then.returns("This forum is where the Sysops post administrative announcements...").then.returns(".")
+    fi = @forum.forum_information
+    assert_equal fi[:from], "Adonis"
+  end
+  
+  def test_forum_information_failure
+    @socket.stubs(:readline).returns("999 Stuff broke")
+    assert_raise(ResponseError) do
+      fi = @forum.forum_information
+    end
+  end
+  
+  def test_set_first_unread
+    @socket.stubs(:readline).returns('206 Value set')
+    @forum.first_unread=2139
+  end
+  
+  def test_set_first_unread_fails
+    @socket.stubs(:readline).returns('999 Stuff Broke')
+    assert_raises(ResponseError) do
+      @forum.first_unread=99999
+    end
+  end
+  
+  def test_first_unread
+    @socket.stubs(:readline).returns("207 RC Value is: 	2281")
+    first = @forum.first_unread
+    assert_equal first, "2281"
+  end
+  
+  def test_first_unread_fails
+    @socket.stubs(:readline).returns("999 Stuff Broke")
+    assert_raises(ResponseError) do
+      first = @forum.first_unread
+    end
+  end
+  
+  def test_post_headers
+    @socket.stubs(:readline).returns("306 Note headers follow").then.returns("noteno:2275	formal-author:acct89144-oldisca/Devil Lady/(hidden)	date:Sat, 16 Jun 2007 00:11:00 GMT	subject:Have you ever wanted to give a little back?  ISCA is	size:670").then.returns("noteno:2280	formal-author:acct493910-oldisca/Bleeding Me/(hidden)	date:Sat, 13 Oct 2007 18:28:00 GMT	subject:Do you have an idea for a permanent forum but aren't sure	size:465").then.returns(".")
+    headers = @forum.post_headers
+    assert_equal headers.class, Hash
+    assert_equal headers.size, 2
+    post = headers['2275']
+    assert_equal post.class, Hash
+    assert_equal post[:author], 'Devil Lady'
+    assert_equal post[:size], '670'
+    assert_equal post[:noteno], '2275'
+  end
+  
+  def test_post_headers_fail
+    @socket.stubs(:readline).returns("999 Stuff broke")
+    assert_raise(ResponseError) do
+      headers = @forum.post_headers
+    end
+  end
+  
+  def test_read
+    @socket.stubs(:readline).returns("302 Note body follows 	noteno:71493	size:66").then.returns("From: Lunenburg").then.returns("Formal-Name: acct123507-oldisca/Lunenburg/(hidden)").then.returns("Date: Wed, 06 Jun 2007 01:02:00 GMT").then.returns("").then.returns("Testing to see if posting via the ISCAweb interface still works.").then.returns(".")
+    post = @forum.read("9999")
+    assert_equal post.class, Raccdoc::Post
+  end
+  
+  def test_read_dammit
+    @socket.stubs(:readline).returns("302 Note body follows 	noteno:71493	size:66").then.returns("From: Lunenburg").then.returns("Formal-Name: acct123507-oldisca/Lunenburg/(hidden)").then.returns("Date: Wed, 06 Jun 2007 01:02:00 GMT").then.returns("").then.returns("Testing to see if posting via the ISCAweb interface still works.").then.returns(".")
+    post = @forum.read!("9999")
+    assert_equal post.class, Raccdoc::Post
+  end
+    
+  def test_create_post
+    @socket.stubs(:readline).returns('350 Send note body 	maxsize:50000').then.returns('205 Note posted as note: 	71508').then.returns("302 Note body follows 	noteno:71493	size:66").then.returns("From: Lunenburg").then.returns("Formal-Name: acct123507-oldisca/Lunenburg/(hidden)").then.returns("Date: Wed, 06 Jun 2007 01:02:00 GMT").then.returns("").then.returns("This is a test").then.returns(".")
+    post = @forum.post("This is a test")
+    assert_equal post.class, Raccdoc::Post
+    assert_equal post.body, "This is a test"
+  end
+  
+  def test_create_post_early_failure
+    @socket.stubs(:readline).returns('999 Stuff broke')
+    assert_raise(ResponseError) do
+      post = @forum.post("This is a test")
+    end
+  end
+  
+  def test_create_post_late_failure
+    @socket.stubs(:readline).returns('350 Send note body 	maxsize:50000').then.returns('999 Stuff broke')
+    assert_raise(ResponseError) do
+      post = @forum.post("This is a test")
+    end
+  end
+  
+  def test_okay_post
+    @socket.stubs(:readline).returns("211 Request okay")
+    assert_equal @forum.post?, true
+  end
+  
+  def test_okay_post_denied
+    @socket.stubs(:readline).returns("408 Permission denied")
+    assert_equal @forum.post?, false
+  end
+  
+  def test_okay_post_fail
+    @socket.stubs(:readline).returns("999 Stuff broke")
+    assert_raise(ResponseError) do
+      @forum.post?
+    end
+  end
+  
+    
+end

data/test/raccdoc_post_test.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class RaccdocPostTest < Test::Unit::TestCase
+  def setup
+    @socket = mock()
+    @socket.stubs(:puts)
+    @socket.stubs(:readline).returns("302 Note body follows 	noteno:71493	size:66").then.returns("From: Lunenburg").then.returns("Formal-Name: acct123507-oldisca/Lunenburg/(hidden)").then.returns("Date: Wed, 06 Jun 2007 01:02:00 GMT").then.returns("").then.returns("Testing to see if posting via the ISCAweb interface still works.").then.returns(".")
+    @post = Raccdoc::Post.new(@socket, 9999)
+  end
+  
+  def test_successful_post_object_creation
+    assert_equal @post.class, Raccdoc::Post
+  end
+  
+  def test_post_object_creation_failure
+    @socket.stubs(:readline).returns("410 No Such Note")
+    assert_raise(ResponseError) do
+      @post = Raccdoc::Post.new(@socket, 9999)
+    end
+  end
+  
+  def test_delete_post
+    @socket.stubs(:readline).returns("208 Note deleted")
+    status = @post.delete
+    assert_equal status, true
+  end
+  
+  def test_delete_failure
+    @socket.stubs(:readline).returns("408 Permission denied")
+    status = @post.delete
+    assert_equal status, false
+  end
+  
+  def test_delete_exception
+    @socket.stubs(:readline).returns("999 Stuff Broke")
+    assert_raise(ResponseError) do 
+      status = @post.delete
+    end
+  end
+  
+  def test_delete_permissions
+    @socket.stubs(:readline).returns("211 Request okay")
+    status = @post.delete?
+    assert_equal status, true
+  end
+  
+  def test_delete_permissions_failure
+    @socket.stubs(:readline).returns("408 Permission denied")
+    status = @post.delete?
+    assert_equal status, false
+  end
+  
+  def test_delete_permissions_exception
+    @socket.stubs(:readline).returns("999 Stuff broke")
+    assert_raise(ResponseError) do
+      status = @post.delete?
+    end
+  end
+    
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'raccdoc'
+require 'rubygems'
+require 'mocha'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: raccdoc
+version: !ruby/object:Gem::Version 
+  version: 0.0.10
+platform: ruby
+authors: 
+- H. Wade Minter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A Ruby way to speak the Raccdoc protocol
+email: minter@lunenburg.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/raccdoc.rb
+- lib/raccdoc/connection.rb
+- lib/raccdoc/forum.rb
+- lib/raccdoc/post.rb
+- raccdoc.gemspec
+- test/raccdoc_connection_test.rb
+- test/raccdoc_forum_test.rb
+- test/raccdoc_post_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/minter/raccdoc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby interface into the Raccdoc BBS API
+test_files: 
+- test/raccdoc_connection_test.rb
+- test/raccdoc_forum_test.rb
+- test/raccdoc_post_test.rb
+- test/test_helper.rb