minter-raccdoc 0.0.2 → 0.0.3

data/CHANGELOG

@@ -0,0 +1,5 @@
+v0.0.3 Documentation updates
+
+v0.0.2 Adding tests, cleaning up gemspec.
+
+v0.0.1 Initial release.

data/Manifest

@@ -4,6 +4,6 @@ LICENSE
 Manifest
 raccdoc.gemspec
 Rakefile
-README.rdoc
+README
 test/raccdoc_connection_test.rb
 test/test_helper.rb

data/README

@@ -0,0 +1,90 @@
+= 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.
+
+== 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.github.com
+* sudo gem install minter-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/lib/raccdoc.rb

@@ -1,6 +1,6 @@
 module Raccdoc
   
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   require 'socket'
   require 'time'
 

data/raccdoc.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{raccdoc}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   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.description = %q{A Ruby interface into the Raccdoc protocol}
   s.email = %q{minter@lunenburg.org}
-  s.extra_rdoc_files = ["lib/raccdoc.rb", "LICENSE", "README"]
-  s.files = ["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.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.has_rdoc = true
   s.homepage = %q{}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Raccdoc", "--main", "README.rdoc"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Raccdoc", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{raccdoc}
   s.rubygems_version = %q{1.3.1}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: minter-raccdoc
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - H. Wade Minter
@@ -28,10 +28,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG
 - lib/raccdoc.rb
 - LICENSE
 - README
 files: 
+- CHANGELOG
 - lib/raccdoc.rb
 - LICENSE
 - Manifest
@@ -49,7 +51,7 @@ rdoc_options:
 - --title
 - Raccdoc
 - --main
-- README.rdoc
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement