minter-raccdoc 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.5 Full test coverage, bug fixes
+
 v0.0.4 Add readers for extra flags, add DAMMIT to post reading.
 
 v0.0.3 Documentation updates

data/Manifest

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

data/lib/raccdoc/connection.rb

@@ -0,0 +1,101 @@
+module Raccdoc
+  class Connection
+
+    attr_reader :host
+
+    # 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 RuntimeError, "Could not connect to #{args[:host]}, port #{args[:port]}\n"
+      end
+
+      response = @socket.readline.chomp
+      unless response.match(/^2/)
+        raise RuntimeError, response
+      end
+
+      if (args[:user] && args[:password])
+        @socket.puts("LOGIN #{args[:user]}\t#{args[:password]}")
+        response = @socket.readline.chomp
+        unless response.match(/^2/)
+          raise RuntimeError, response
+        end
+      end
+      @host = args[:host]
+    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 RuntimeError, 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 RuntimeError, 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,202 @@
+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 RuntimeError, 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.
+    def noteids
+      noteids = Array.new
+      @socket.puts("XHDR noteno")
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise RuntimeError, 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 RuntimeError, 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 RuntimeError, 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 RuntimeError, 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}")
+      response = @socket.readline.chomp
+      unless response.match(/^3/)
+        raise RuntimeError, 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 RuntimeError, 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 RuntimeError, 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 RuntimeError, response
+      end
+    end
+  end
+end

data/lib/raccdoc/post.rb

@@ -0,0 +1,84 @@
+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 RuntimeError, 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[:author] = post[:'formal-author'] ? post[:'formal-author'].split('/')[1] : 'Anonymous'
+
+      post[:body] = ""
+      while (line = @socket.readline)
+        break if line.match(/^\.$/)
+        post[:body] << line
+      end
+
+      @id = post[:id]
+      @date = post[:date]
+      @author = post[:author]
+      @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 RuntimeError, 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 RuntimeError, response
+      end
+    end
+  end
+end

data/lib/raccdoc.rb

@@ -1,389 +1,12 @@
 module Raccdoc
   
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
   require 'socket'
   require 'time'
-
-  class Connection
-    
-    attr_reader :host
-    
-    # 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 RuntimeError, "Could not connect to #{args[:host]}, port #{args[:port]}\n"
-      end
-    
-      response = @socket.readline.chomp
-      unless response.match(/^2/)
-        raise RuntimeError, response
-      end
-
-      if (args[:user] && args[:password])
-        @socket.puts("LOGIN #{args[:user]}\t#{args[:password]}")
-        response = @socket.readline.chomp
-        unless response.match(/^2/)
-          raise RuntimeError, response
-        end
-      end
-      @host = args[:host]
-    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 RuntimeError, response
-        end
-        @socket.close
-      end
-    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 RuntimeError, 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
   
-  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 RuntimeError, 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]
-    end
-    
-    # Returns an array of all current post IDs in the forum.
-    def noteids
-      noteids = Array.new
-      @socket.puts("XHDR noteno")
-      response = @socket.readline.chomp
-      unless response.match(/^3/)
-        raise RuntimeError, 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 RuntimeError, 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 RuntimeError, 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 RuntimeError, 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}")
-      response = @socket.readline.chomp
-      unless response.match(/^3/)
-        raise RuntimeError, 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 RuntimeError, 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 RuntimeError, 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 RuntimeError, response
-      end
-    end
-  end
-  
-  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 RuntimeError, 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[:author] = post[:'formal-author'] ? post[:'formal-author'].split('/')[1] : 'Anonymous'
+  $:.unshift(File.dirname(__FILE__))
+  require 'raccdoc/connection'
+  require 'raccdoc/forum'
+  require 'raccdoc/post'
 
-      post[:body] = ""
-      while (line = @socket.readline)
-        break if line.match(/^\.$/)
-        post[:body] << line
-      end
-      
-      @id = post[:id]
-      @date = post[:date]
-      @author = post[:author]
-      @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 RuntimeError, 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 response.match(/^2/)
-        raise RuntimeError, response
-      end
-    end
-  end
 end

data/raccdoc.gemspec

@@ -2,23 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{raccdoc}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["H. Wade Minter"]
   s.date = %q{2009-01-13}
   s.description = %q{A Ruby interface into the Raccdoc protocol}
   s.email = %q{minter@lunenburg.org}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/raccdoc.rb", "LICENSE", "README"]
-  s.files = ["CHANGELOG", "lib/raccdoc.rb", "LICENSE", "Manifest", "raccdoc.gemspec", "Rakefile", "README", "test/raccdoc_connection_test.rb", "test/test_helper.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/raccdoc/connection.rb", "lib/raccdoc/forum.rb", "lib/raccdoc/post.rb", "lib/raccdoc.rb", "LICENSE", "README.rdoc"]
+  s.files = ["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"]
   s.has_rdoc = true
   s.homepage = %q{}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Raccdoc", "--main", "README"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Raccdoc", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{raccdoc}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{A Ruby interface into the Raccdoc protocol}
-  s.test_files = ["test/raccdoc_connection_test.rb", "test/test_helper.rb"]
+  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

data/test/raccdoc_connection_test.rb

@@ -3,14 +3,15 @@ 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
-    TCPSocket.expects(:new).returns(@socket)
-    @socket.expects(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
-    assert_equal bbs.class, Raccdoc::Connection
-    assert_equal bbs.host, "test.bbs.example"
+    assert_equal @bbs.class, Raccdoc::Connection
+    assert_equal @bbs.host, "test.bbs.example"
   end
   
   def test_connection_refused_anonymous
@@ -40,66 +41,49 @@ class RaccdocConnectionTest < Test::Unit::TestCase
   end
   
   def test_logout_succeeds
-    @socket.stubs(:puts)
     @socket.stubs(:close)
     @socket.stubs(:closed?).returns(false)
-    TCPSocket.expects(:new).returns(@socket)
-    @socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==").then.returns("201 Session ended")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
-    bbs.logout
+    @socket.stubs(:readline).returns("201 Session ended")
+    result = @bbs.logout
+    assert_equal result, true
   end
   
   def test_logout_fails
-    @socket.stubs(:puts)
     @socket.stubs(:close)
     @socket.stubs(:closed?).returns(false)
-    TCPSocket.expects(:new).returns(@socket)
-    @socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==").then.returns("999 Something Broke")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
+    @socket.stubs(:readline).returns("999 Something Broke")
     assert_raise(RuntimeError) do
-      bbs.logout
+      @bbs.logout
     end
   end
   
   def test_connected
     @socket.stubs(:puts)
     @socket.stubs(:closed?).returns(false)
-    TCPSocket.expects(:new).returns(@socket)
-    @socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==").then.returns("999 Something Broke")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
-    assert_equal bbs.connected?, true
+    @socket.stubs(:readline).returns("999 Something Broke")
+    assert_equal @bbs.connected?, true
   end
   
   def test_forums_success
-    @socket.stubs(:puts)
-    TCPSocket.expects(:new).returns(@socket)
-    @socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==").then.returns("301 Topic list follows").then.returns("topic:0	name:Lobby	lastnote:2331	flags:nosubject,sparse	admin:acct578247-oldisca/Elvis/(hidden)").then.returns(".")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
-    forums = bbs.forums
+    @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(:puts)
-    TCPSocket.expects(:new).returns(@socket)
-    @socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==").then.returns("999 Stuff Broke")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
+    @socket.stubs(:readline).returns("999 Stuff Broke")
     assert_raise(RuntimeError) do
-      forums = bbs.forums
+      forums = @bbs.forums
     end
   end
   
   def test_jump
-    @socket.stubs(:puts)
     @forum = mock()
     @forum.expects(:name).returns("Lobby")
-    TCPSocket.expects(:new).returns(@socket)
     Raccdoc::Forum.expects(:new).returns(@forum)
-    @socket.stubs(:readline).returns("200 Server started 	seed:Ci0B2YeMio8ftYjElTa+EQ==")
-    bbs = Raccdoc::Connection.new(:host => 'test.bbs.example')
-    forum = bbs.jump(0)
+    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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) 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(RuntimeError) do
+      status = @post.delete?
+    end
+  end
+    
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: minter-raccdoc
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - H. Wade Minter
@@ -29,18 +29,26 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
+- lib/raccdoc/connection.rb
+- lib/raccdoc/forum.rb
+- lib/raccdoc/post.rb
 - lib/raccdoc.rb
 - LICENSE
-- README
+- README.rdoc
 files: 
 - CHANGELOG
+- lib/raccdoc/connection.rb
+- lib/raccdoc/forum.rb
+- lib/raccdoc/post.rb
 - lib/raccdoc.rb
 - LICENSE
 - Manifest
 - raccdoc.gemspec
 - Rakefile
-- README
+- README.rdoc
 - test/raccdoc_connection_test.rb
+- test/raccdoc_forum_test.rb
+- test/raccdoc_post_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: ""
@@ -51,7 +59,7 @@ rdoc_options:
 - --title
 - Raccdoc
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -75,4 +83,6 @@ specification_version: 2
 summary: A Ruby interface into the Raccdoc protocol
 test_files: 
 - test/raccdoc_connection_test.rb
+- test/raccdoc_forum_test.rb
+- test/raccdoc_post_test.rb
 - test/test_helper.rb