crypt-fog 0.1.0 → 1.0.0

data/CHANGES

@@ -1,3 +1,13 @@
-0.1.0 - 30-Jul-2003
-===================
+== 1.0.0 - 12-Jun-2005
+* Moved project to RubyForge.
+* Removed the 'doc' directory.  Because the documentation is so short, that
+  information is now in the README file, which is rdoc friendly.
+* Some test suite cleanup and added tests.
+* Made documents rdoc friendly.
+* Simplified install.rb.
+* Removed INSTALL file.  That information is now included as part of the
+  README file.
+* Added a gemspec.
+
+== 0.1.0 - 30-Jul-2003
 - Initial release

data/MANIFEST

@@ -1,13 +1,10 @@
 MANIFEST
 CHANGES
-INSTALL
 README
 install.rb
-quickenc.rb
+crypt-fog.gemspec
 
-doc/fog.html
-doc/fog.rd2
-doc/fog.txt
+bin/quickenc
 
 lib/crypt/fog.rb
 

data/README

@@ -1,14 +1,62 @@
-crypt-fog is a simple encryption mechanism, but slightly better
-than Rot13.  It's primary goal is to provide a reasonable amount
-of obfuscation without having to resort to public/private key
-exchanges, etc.
+== Description
+   The crypt-fog package is a simple encryption mechanism, but slightly better
+   than Rot13.  It's primary goal is to provide a reasonable amount
+   of obfuscation without having to resort to public/private key
+   exchanges, etc.
 
-For hyper-sensitive data I recommend using a more advanced encryption scheme.
+   For hyper-sensitive data I recommend using a more advanced encryption
+   scheme.
 
-In addition to the module, a stand-alone program is included called "quickenc.rb"
-that takes both a string and a number as arguments and returns your encrypted string.
-You can then copy/paste that string to a .rc file.  Just remember the number you
-picked in order to decrypt it.
+   In addition to the module, a stand-alone program is included called
+   "quickenc" that takes both a string and a number as arguments and returns
+   your encrypted string.  You can then copy/paste that string to a .rc file.
+   Just remember the number you picked in order to decrypt it.
 
-Usage: ruby quickenc.rb -s "hello" -d 1688
-       ruby quickenc.rb -f "test.txt" -d 1066
+   Usage: ruby quickenc.rb -s "hello" -d 1688
+          ruby quickenc.rb -f "test.txt" -d 1066
+          
+   Modify the shebang line as needed.
+          
+== Installation
+   ruby test/tc_fog.rb (optional)
+   ruby install.rb
+   
+== Synopsis
+   include Crypt
+   s = Fog.new("hello",2003)
+   p s # ";8??B"
+   p s.decrypt # "hello"
+
+   Fog.decrypt(";8??B",2003) # "hello"
+
+== Constants
+VERSION
+   The current version of the module, returned as a String.
+
+== Class Methods
+Fog.new(string, degree=13)
+   Creates and returns a new Fog object, which is your obfuscated string.
+   The degree is the value used to obfuscate the string.
+
+   Means of encryption not provided here. You'll have to look at the code. :)
+
+Fog.decrypt(string, degree=13)
+   Returns a (presumably) decrypted String.  Should be used when the string
+   comes from an external source.
+
+== Instance Methods
+Fog#decrypt
+   Returns a decrypted String, using the degree that was provided during
+   initialization.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2003-2005 Daniel J. Berger
+   All rights reserved.
+
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   imperator on IRC (irc.freenode.net)

data/bin/quickenc

@@ -1,10 +1,25 @@
-$:.unshift Dir.pwd + "/lib"
+#!/usr/local/bin/ruby
+#
+# This script allows you to encode a string or file using the
+# crypt-fog Ruby package.
+#
+# Author:
+#		Daniel J. Berger
+#
+# Warranty:
+#		This package is provided "as is" and without any express or
+#    	implied warranties, including, without limitation, the implied
+#    	warranties of merchantability and fitness for a particular purpose.
+#
+# License: Ruby's
+#
+# Copyright: (C) 2003-2005 Daniel J. Berger.  All rights reserved.
 
 require "getoptlong"
 require "crypt/fog"
 include Crypt
 
-QUICKENC_VERSION = 1.0
+QUICKENC_VERSION = 1.1
 
 def usage
    print <<-HELP

data/lib/crypt/fog.rb

@@ -1,7 +1,6 @@
 module Crypt
 
-   # Surprise!
-
-   module_eval("\024\035\022$$\321\367 \030\321\355\321\004%#\032\037\030\273\273\321\321\321\a\366\003\004\372\000\377\321\356\321\323\341\337\342\337\341\323\273\273\321\321\321\025\026\027\321\032\037\032%\032\022\035\032+\026\331$%#\032\037\030\335\025\026\030#\026\026\356\342\344\332\273\321\321\321\321\321\321\361\025\026\030#\026\026\321\356\321\025\026\030#\026\026\337% \020\032\321\273\321\321\321\321\321\321$%#\321\356\321\026\037\024#*!%\331$%#\032\037\030\335\025\026\030#\026\026\332\273\321\321\321\321\321\321$&!\026#\331$%#\332\273\321\321\321\026\037\025\273\273\321\321\321\025\026\027\321\025\026\024#*!%\273\321\321\321\321\321\321&\037!\022\024\034\331\323\364\333\323\332\337\036\022!,\321-\026-\321\026\321\336\356\321\361\025\026\030#\026\026\321.\337!\022\024\034\331\323\364\333\323\332\273\321\321\321\026\037\025\273\273\321\321\321\025\026\027\321% \020$\273\321\321\321\321\321\321$\026\035\027\337\032\037$!\026\024%\273\321\321\321\026\037\025\273\273\321\321\321\025\026\027\321$\026\035\027\337\025\026\024#*!%\331$%#\335\025\026\030#\026\026\356\342\344\332\273\321\321\321\321\321\321$%#\337&\037!\022\024\034\331\323\364\333\323\332\337\036\022!,\321-\026-\321\026\321\336\356\321\025\026\030#\026\026\321.\337!\022\024\034\331\323\364\333\323\332\273\321\321\321\026\037\025\273\273\321\321\321!#\032'\022%\026\273\273\321\321\321\321\321\321\025\026\027\321\026\037\024#*!%\331$%#\356$\026\035\027\335\025\026\030#\026\026\356\361\025\026\030#\026\026\332\273\321\321\321\321\321\321\321\321\321$%#\337&\037!\022\024\034\331\323\364\333\323\332\337\036\022!,\321-\026-\321\026\321\334\356\321\025\026\030#\026\026\321.\337!\022\024\034\331\323\364\333\323\332\273\321\321\321\321\321\321\026\037\025\273\273\026\037\025".unpack("C*").map{ |e| e -= 1969 }.pack("C*"))
+   # nyuck, nyuck, nyuck
+   module_eval("\024\035\022$$\321\367 \030\321\355\321\004%#\032\037\030\273\321\321\321\a\366\003\004\372\000\377\321\356\321\323\342\337\341\337\341\323\273\321\321\321\025\026\027\321\032\037\032%\032\022\035\032+\026\331$%#\032\037\030\335\321\025\026\030#\026\026\356\342\344\332\273\321\321\321\321\321\321\361\025\026\030#\026\026\321\356\321\025\026\030#\026\026\337% \020\032\273\321\321\321\321\321\321$%#\321\356\321\026\037\024#*!%\331$%#\032\037\030\335\321\025\026\030#\026\026\332\273\321\321\321\321\321\321$&!\026#\331$%#\332\273\321\321\321\026\037\025\273\273\321\321\321\025\026\027\321\025\026\024#*!%\273\321\321\321\321\321\321&\037!\022\024\034\331\323\364\333\323\332\337\036\022!,\321-\026-\321\026\321\336\356\321\361\025\026\030#\026\026\321.\337!\022\024\034\331\323\364\333\323\332\273\321\321\321\026\037\025\273\273\321\321\321\025\026\027\321% \020$\273\321\321\321\321\321\321$\026\035\027\337\032\037$!\026\024%\273\321\321\321\026\037\025\273\273\321\321\321\025\026\027\321$\026\035\027\337\025\026\024#*!%\331$%#\335\321\025\026\030#\026\026\356\342\344\332\273\321\321\321\321\321\321$%#\337&\037!\022\024\034\331\323\364\333\323\332\337\036\022!,\321-\026-\321\026\321\336\356\321\025\026\030#\026\026\321.\337!\022\024\034\331\323\364\333\323\332\273\321\321\321\026\037\025\273\273\321\321\321!#\032'\022%\026\273\273\321\321\321\025\026\027\321\026\037\024#*!%\331$%#\356$\026\035\027\335\321\025\026\030#\026\026\356\361\025\026\030#\026\026\332\273\321\321\321\321\321\321$%#\337&\037!\022\024\034\331\323\364\333\323\332\337\036\022!,\321-\026-\321\026\321\334\356\321\025\026\030#\026\026\321.\337!\022\024\034\331\323\364\333\323\332\273\321\321\321\026\037\025\273\026\037\025\273".unpack("C*").map{ |e| e -= 1969 }.pack("C*"))
 
 end

data/test/tc_fog.rb

@@ -1,14 +1,15 @@
-###########################
+#############################
 # tc_fog.rb
 #
 # Test suite for crypt-fog.
-###########################
-if File.basename(Dir.pwd) == "test"
-   Dir.chdir('..')
-end
+#############################
+base = File.basename(Dir.pwd)
 
-$:.unshift Dir.pwd
-$:.unshift Dir.pwd + "/lib"
+if base == "test" || base =~ /crypt-fog/
+   Dir.chdir("..") if base == "test"
+   $LOAD_PATH.unshift Dir.pwd
+   $LOAD_PATH.unshift Dir.pwd + "/lib"
+end
 
 require "test/unit"
 require "crypt/fog"
@@ -19,25 +20,31 @@ class TC_Fog < Test::Unit::TestCase
       @f = Fog.new("hello")
    end
 
-   def test_01_version
-      assert_equal("0.1.0",Fog::VERSION,"Bad version")
+   def test_version
+      assert_equal("1.0.0", Fog::VERSION, "Bad version")
    end
 
-   def test_02_class_methods
+   def test_constructor
       assert_nothing_raised{ Fog.new("string") }
-      assert_nothing_raised{ Fog.new("string",55) }
+      assert_nothing_raised{ Fog.new("string", 55) }
+   end
+
+   def test_class_decrypt
+      assert_respond_to(Fog, :decrypt)
       assert_nothing_raised{ Fog.decrypt("string") }
-      assert_nothing_raised{ Fog.decrypt("string",66) }
+      assert_nothing_raised{ Fog.decrypt("string", 66) }
+      assert_equal("hello", Fog.decrypt(";8??B", 2003))
    end
 
-   def test_03_instance_methods
+   def test_instance_decrypt
+      assert_respond_to(@f, :decrypt)
       assert_nothing_raised{ @f.decrypt }
-      assert_respond_to(@f,:decrypt)
+      assert_equal("hello", @f.decrypt)
    end
 
-   def test_04_types
-      assert_equal(Crypt::Fog,@f.class)
-      assert_equal(String,@f.decrypt.class)
+   def test_types
+      assert_kind_of(Crypt::Fog, @f)
+      assert_kind_of(String, @f.decrypt)
    end
 
    def teardown

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.1
+rubygems_version: 0.8.10
 specification_version: 1
 name: crypt-fog
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2004-11-05
-summary: "crypt-fog is a simple encryption mechanism, but slightly better than Rot13.  It's primary goal is to provide a reasonable amount of obfuscation without having to resort to public/private key exchanges, etc."
+  version: 1.0.0
+date: 2005-06-12
+summary: "crypt-fog is a simple encryption mechanism, but slightly better than Rot13. 
+  It's primary goal is to provide a reasonable amount of obfuscation without
+  having to resort to public/private key exchanges, etc."
 require_paths: 
   - lib
-  - lib
-author: Daniel J. Berger
-email: djberg96@yahoo.com
-homepage: http://ruby-miscutils.sourceforge.net/fog.html
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/shards
 rubyforge_project: 
-description: "crypt-fog is a simple encryption mechanism, but slightly better than Rot13.  It's primary goal is to provide a reasonable amount of obfuscation without having to resort to public/private key exchanges, etc."
+description: A simple encryption scheme
 autorequire: crypt/fog
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
     - 
@@ -26,24 +26,13 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 0.0.0
   version: 
 platform: ruby
+authors: 
+  - Daniel J. Berger
 files: 
-  - bin
+  - lib/crypt/fog.rb
+  - README
   - CHANGES
-  - crypt-fog-0.1.0.gem
-  - crypt-fog.gemspec
-  - doc
-  - INSTALL
-  - install.rb
-  - lib
   - MANIFEST
-  - README
-  - test
-  - bin/quickenc
-  - doc/fog.html
-  - doc/fog.rd2
-  - doc/fog.txt
-  - lib/crypt
-  - lib/crypt/fog.rb
   - test/tc_fog.rb
 test_files: 
   - test/tc_fog.rb
@@ -52,7 +41,7 @@ rdoc_options:
   - README
 extra_rdoc_files: 
   - README
-  - doc/fog.txt
+  - CHANGES
 executables: 
   - quickenc
 extensions: []

data/INSTALL

@@ -1,7 +0,0 @@
-To install
-==========
-ruby install.rb
-
-To run test suite
-=================
-ruby test/tc_fog.rb

data/crypt-fog.gemspec

@@ -1,21 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{crypt-fog}
-  s.version = "0.1.0"
-  s.date = %q{2004-11-05}
-  s.summary = %q{crypt-fog is a simple encryption mechanism, but slightly better
-than Rot13.  It's primary goal is to provide a reasonable amount
-of obfuscation without having to resort to public/private key
-exchanges, etc.}
-  s.description = s.summary
-  s.author = %q{Daniel J. Berger}
-  s.email = %q{djberg96@yahoo.com}
-  s.files =  Dir['**/**']
-  s.homepage = %q{http://ruby-miscutils.sourceforge.net/fog.html}
-  s.autorequire = %q{crypt/fog}
-  s.require_paths <<  %q{lib}
-  s.bindir = "bin"
-  s.executables = ["quickenc"]
-  s.extra_rdoc_files = ["README", "doc/fog.txt"]
-  s.rdoc_options = ["--main", "README"]
-  s.test_files = ["test/tc_fog.rb"]
-end

data/doc/fog.html

@@ -1,56 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE html 
-  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<title>fog.rd2</title>
-</head>
-<body>
-<h1><a name="label:0" id="label:0">Description</a></h1><!-- RDLabel: "Description" -->
-<pre>A simple string obfuscator.</pre>
-<h1><a name="label:1" id="label:1">Synopsis</a></h1><!-- RDLabel: "Synopsis" -->
-<pre>include Crypt
-s = Fog.new("hello",2003)
-p s # ";8??B"
-p s.decrypt # "hello"
-
-Fog.decrypt(";8??B",2003) # "hello"</pre>
-<h1><a name="label:2" id="label:2">Constants</a></h1><!-- RDLabel: "Constants" -->
-<dl>
-<dt><a name="label:3" id="label:3"><code>VERSION</code></a><!-- RDLabel: "VERSION" -->
-</dl>
-<pre>The current version of the module, returned as a String.</pre>
-<h1><a name="label:4" id="label:4">Class Methods</a></h1><!-- RDLabel: "Class Methods" -->
-<dl>
-<dt><a name="label:5" id="label:5"><code>Fog.new(<var>string</var>,<var>degree</var>=<var>13</var>)</code></a></dt><!-- RDLabel: "Fog.new" -->
-<dd>
-<p>Creates and returns a new Fog object, which is your obfuscated string.
-The degree is the value used to obfuscate the string.  Method not provided here.
-You'll have to look at the code. :)</p></dd>
-<dt><a name="label:6" id="label:6"><code>Fog.decrypt(<var>string</var>,<var>degree</var>=<var>13</var>)</code></a></dt><!-- RDLabel: "Fog.decrypt" -->
-<dd>
-<p>Returns a (presumably) decrypted String.  Should be used when your string comes
-from an external source.</p></dd>
-</dl>
-<h1><a name="label:7" id="label:7">Instance Methods</a></h1><!-- RDLabel: "Instance Methods" -->
-<dl>
-<dt><a name="label:8" id="label:8"><code>Fog#decrypt</code></a></dt><!-- RDLabel: "Fog#decrypt" -->
-<dd>
-<p>Returns a decrypted String, using the degree that was provided during
-initialization.</p></dd>
-</dl>
-<h1><a name="label:9" id="label:9">Notes</a></h1><!-- RDLabel: "Notes" -->
-<pre>Fog is a subclass of String.</pre>
-<h1><a name="label:10" id="label:10">License</a></h1><!-- RDLabel: "License" -->
-<pre>Artistic</pre>
-<h1><a name="label:11" id="label:11">Copyright</a></h1><!-- RDLabel: "Copyright" -->
-<pre>(C) 2003 Daniel J. Berger
-All rights reserved.</pre>
-<h1><a name="label:12" id="label:12">Author</a></h1><!-- RDLabel: "Author" -->
-<pre>Daniel J. Berger
-djberg96 at yahoo dot com
-rubyhacker1 on IRC</pre>
-
-</body>
-</html>

data/doc/fog.rd2

@@ -1,37 +0,0 @@
-=begin
-= Description
-   A simple string obfuscator.
-= Synopsis
-   include Crypt
-   s = Fog.new("hello",2003)
-   p s # ";8??B"
-   p s.decrypt # "hello"
-
-   Fog.decrypt(";8??B",2003) # "hello"
-= Constants
---- VERSION
-   The current version of the module, returned as a String.
-= Class Methods
---- Fog.new(string,degree=13)
-    Creates and returns a new Fog object, which is your obfuscated string.
-    The degree is the value used to obfuscate the string.  Method not provided here.
-    You'll have to look at the code. :)
---- Fog.decrypt(string,degree=13)
-    Returns a (presumably) decrypted String.  Should be used when your string comes
-    from an external source.
-= Instance Methods
---- Fog#decrypt
-    Returns a decrypted String, using the degree that was provided during
-    initialization.
-= Notes
-    Fog is a subclass of String.
-= License
-    Artistic
-= Copyright
-    (C) 2003 Daniel J. Berger
-    All rights reserved.
-= Author
-    Daniel J. Berger
-    djberg96 at yahoo dot com
-    rubyhacker1 on IRC
-=end

data/doc/fog.txt

@@ -1,53 +0,0 @@
-Description
-===========
-A simple string obfuscator.
-
-Synopsis
-========
-include Crypt
-s = Fog.new("hello",2003)
-p s # ";8??B"
-p s.decrypt # "hello"
-
-Fog.decrypt(";8??B",2003) # "hello"
-
-Constants
-=========
-VERSION
-   The current version of the module, returned as a String.
-
-Class Methods
-=============
-Fog.new(string,degree=13)
-   Creates and returns a new Fog object, which is your obfuscated string.
-   The degree is the value used to obfuscate the string.  Method not provided here.
-   You'll have to look at the code. :)
-
-Fog.decrypt(string,degree=13)
-   Returns a (presumably) decrypted String.  Should be used when the string comes
-   from an external source.
-
-Instance Methods
-================
-Fog#decrypt
-   Returns a decrypted String, using the degree that was provided during
-   initialization.
-
-Notes
-=====
-Fog is a subclass of String.
-
-License
-=======
-Artistic
-
-Copyright
-=========
-(C) 2003 Daniel J. Berger
-All rights reserved.
-
-Author
-======
-Daniel J. Berger
-djberg96 at yahoo dot com
-rubyhacker1 on IRC

data/install.rb

@@ -1,19 +0,0 @@
-require "rbconfig"
-require "ftools"
-include Config
-
-sitedir = CONFIG['sitelibdir']
-file = "lib/crypt/fog.rb"
-
-begin
-   unless File.exist?("#{sitedir}/crypt")
-      Dir.mkdir("#{sitedir}/crypt")
-   end
-   puts "cp #{file} #{sitedir}/crypt"
-   File.copy(file,"#{sitedir}/crypt")
-rescue => e
-   puts "Unable to copy files to sitelibdir [#{sitedir}]: #{e}"
-   exit
-end
-
-puts "crypt-fog installed successfully"