base32_pure 0.0.0 → 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+group :development do
+  gem 'jeweler'
+  gem 'rspec', '<2.0'
+end

data/README.rdoc

@@ -1,18 +1,16 @@
 = base32_pure
 
-Encodes and decodes binary tokens to and from base32.
+Encodes and decodes binary string or integer tokens to and from base32.
 
 == Description
 
-It uses the Crockford alphabet defined defined at http://www.crockford.com/wrmg/base32.html
-- which is probably not the most efficient.
+It uses the Crockford alphabet defined at http://www.crockford.com/wrmg/base32.html - 
+which is probably not the most efficient, but it is tolerant to user mistakes.
 
-It is quite tolerant to user mistakes.
-
- * It's case insensitive
- * I,l and 1 maps to the same value
- * 0 and O maps to the same value
- * U is excluded to reduce the likelyhood of accidental obscenity
+* It's case insensitive
+* I, l and 1 maps to the same value
+* 0 and O maps to the same value
+* U is excluded to reduce the likelyhood of accidental obscenity
 
 == Usage
 
@@ -24,12 +22,24 @@ It is quite tolerant to user mistakes.
  hypenated = Base32::Crockford.hypenate(encoded)
  Base32::Crockford.decode(hypenated)
 
+ # Fixnum and Bignum should work as well
+ encoded = Base32::Crockford.encode(12345)
+ Base32::Crockford.decode(encoded, :integer)
+
+
+ # Typical use case
+ require 'uuidtools'
+
+ digest = UUIDTools::UUID.random_create.raw
+ base32_token = Base32::Crockford.encode(digest)
+ 
+
 == Features/problems
 
 The optional check value is not implemented.
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "base32_pure"
     gem.summary = %Q{Encode and decode tokens to and from base32.}
-    gem.description = %Q{Pure ruby libary. Using the crockford alphabeth}
+    gem.description = %Q{Pure ruby libary. Using the crockford alphabet.}
     gem.email = "rune@epubify.com"
     gem.homepage = "http://github.com/wrimle/base32_pure"
     gem.authors = ["Rune Myrland"]

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/base32/crockford.rb

@@ -1,6 +1,23 @@
+# Extend fixnum with an each_byte method
 
 module Base32
 
+  class NormalizedInteger
+    def initialize v
+      @value = v
+    end
+
+
+    def each_byte &blk
+      v = @value
+      while v > 0
+        yield (v & 255)
+        v >>= 8
+      end
+    end
+  end
+
+
   class Crockford
     ENCODE = "0123456789ABCDEFGHJKMNPQRSTVWXYZ"
     DECODE = {
@@ -38,8 +55,14 @@ module Base32
       'Z' => 31,
     }
 
+
     def self.encode v
-      normalized = v.reverse
+      if v.respond_to?(:integer?) && v.integer?
+        normalized = NormalizedInteger.new(v)
+      else
+        normalized = v.reverse
+      end
+ 
       n = 0
       bits = 0
       res = ""
@@ -63,12 +86,13 @@ module Base32
       v.reverse.gsub(/(\w\w\w\w\w)/, "\\1-").gsub(/-$/, "").downcase.reverse
     end
 
-    def self.decode v
+    def self.decode v, to = :binary_string
       normalized = v.upcase.tr("OILU", "011").tr("-", "").reverse
 
       n = 0
       bits = 0
       res = ""
+      res.force_encoding("binary") if res.respond_to?(:force_encoding)
       normalized.each_byte do |b|
         n += (DECODE[ b.chr ] << bits)
         bits += 5
@@ -81,8 +105,19 @@ module Base32
       end
       res << n if n != 0
       res << 0 if res.empty?
+      res = res.reverse
 
-      res.reverse
+      case to
+      when :integer
+        v = 0
+        res.each_byte do |byte|
+          v <<= 8
+          v |= byte
+        end
+        v
+      else
+        res
+      end
     end
   end
 end

data/spec/base32_pure_spec.rb

@@ -6,11 +6,19 @@ describe "Base32" do
   include Base32
 
   context "Crockford" do
+
     it "encodes a string to base 32" do
       encoded = Base32::Crockford.encode("A")
       encoded.should == "21"
+    end
+
+    it "encodes a fixnum to base 32" do
+      encoded = Base32::Crockford.encode(12)
+      encoded.should == "C9J"
+    end
 
-      puts Base32::Crockford.hypenate(Base32::Crockford.encode("a test"))
+    it "encodes a fixnum the same as the equivalent string" do
+      Base32::Crockford.encode(12).should == Base32::Crockford.encode("12")
     end
 
     it "decodes a string from base 32" do
@@ -52,6 +60,7 @@ describe "Base32" do
 
     it "allows hypenation" do
       string = "21ab0devsdagjølp58"
+      string.force_encoding("binary") if string.respond_to?(:force_encoding)
       encoded = Base32::Crockford.hypenate(Base32::Crockford.encode(string))
       decoded = Base32::Crockford.decode(encoded)
 

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: base32_pure
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 0
-  version: 0.0.0
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
 - Rune Myrland
@@ -15,26 +10,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 +02:00
+date: 2011-05-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 2
-        - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id001
-description: Pure ruby libary. Using the crockford alphabeth
+  prerelease: false
+  version_requirements: *id003
+description: Pure ruby libary. Using the crockford alphabet.
 email: rune@epubify.com
 executables: []
 
@@ -45,7 +57,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -60,8 +72,8 @@ homepage: http://github.com/wrimle/base32_pure
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,26 +81,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Encode and decode tokens to and from base32.
-test_files: 
-- spec/base32_pure_spec.rb
-- spec/spec_helper.rb
+test_files: []
+

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC