minter-raccdoc 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.4 Add readers for extra flags, add DAMMIT to post reading.
+
 v0.0.3 Documentation updates
 
 v0.0.2 Adding tests, cleaning up gemspec.

data/README

@@ -10,6 +10,8 @@ Raccdoc is an API into the data of several classic telnet-based BBS systems, inc
  
 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'

data/lib/raccdoc.rb

@@ -1,6 +1,6 @@
 module Raccdoc
   
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
   require 'socket'
   require 'time'
 
@@ -71,6 +71,9 @@ module Raccdoc
     # * 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}"
@@ -105,14 +108,18 @@ module Raccdoc
     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 three variables exposed through attr_reader:
+    # 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}"
@@ -129,6 +136,18 @@ module Raccdoc
         @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]
@@ -242,6 +261,11 @@ module Raccdoc
       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.
@@ -286,8 +310,9 @@ module Raccdoc
     attr_reader :date
     attr_reader :author
     attr_reader :body
+    attr_reader :authority
     
-    # Creates a new Raccdoc::Post object by reading the specified post.
+    # 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:
     #
@@ -295,9 +320,11 @@ module Raccdoc
     # * 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.
-    def initialize(socket,postid)
+    # * authority - either "Sysop" or "Forum Moderator" if the post was made with that header.
+    def initialize(socket,postid,args={})
       @socket = socket
-      @socket.puts "READ #{postid}"
+      dammit = args[:dammit] ? '' : 'DAMMIT'
+      @socket.puts "READ #{postid.to_s} #{dammit}"
       response = @socket.readline.chomp
       unless response.match(/^3/)
         raise RuntimeError, response
@@ -325,6 +352,7 @@ module Raccdoc
       @date = post[:date]
       @author = post[:author]
       @body = post[:body]
+      @authority = post[:authority]
       return post
     end
     

data/raccdoc.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{raccdoc}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   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-12}
+  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"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: minter-raccdoc
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - H. Wade Minter
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-12 00:00:00 -08:00
+date: 2009-01-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency