base58_gmp 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 0.0.7
+- Add Bitcoin suppport
+- Refactor API
+
 = 0.0.6
 - Update encode API
 

data/README.rdoc

@@ -1,6 +1,6 @@
 = Base58GMP
 
-High speed Base58 encoding using GMP with MD5 support and transcoding between GMP and Flickr implementations.
+High speed Base58 encoding using GMP with MD5 support and transcoding between Flickr, Bitcoin and GMP alphabets.
 
 == Installation
 
@@ -21,40 +21,52 @@ Download and install base58_gmp with the following:
   # Encode GMP::Z Int as Base58
   Base58GMP.encode(GMP::Z(12345))                 # => 4ER
 
-  # Encode as Base58 using GMP alphabet
+  # Encode as Base58 using alternate alphabets
+  Base58GMP.encode(12345, 'bitcoin')              # => 4fr
   Base58GMP.encode(12345, 'gmp')                  # => 3cn
 
   # Decode Base58 as GMP::Z Integer
   Base58GMP.decode('4ER')                         # => 12345
 
-  # Decode Base58 as GMP::Z Integer using GMP alphabet
+  # Decode Base58 as GMP::Z Integer using alternate alphabets
+  Base58GMP.decode('4fr', 'bitcoin')              # => 12345
   Base58GMP.decode('3cn', 'gmp')                  # => 12345
 
   # MD5 Base58 Digest
   Base58GMP.md5('foo@bar.com')                    # => w6fdCRXnUXyz7EtDn5TgN9
 
-  # Convert between Flickr and GMP
-  Base58GMP.flickr_to_gmp('123456789abcdefghijk') # => 0123456789ABCDEFGHIJ
-  Base58GMP.gmp_to_flickr('0123456789ABCDEFGHIJ') # => 123456789abcdefghijk
+  # Convert between alphabets
+  Base58GMP.from_to('123456789abcdefghijk','flickr','gmp') # => 0123456789ABCDEFGHIJ
+  Base58GMP.from_to('0123456789ABCDEFGHIJ','gmp','flickr') # => 123456789abcdefghijk
 
 == Notes
 
-=== Base58 Implementations - Flickr and GMP
+=== Base58 Implementations - Flickr, Bitcoin and GMP
 
-This class supports the Base58 implementations used by Flickr and GMP.
+This class supports the Base58 alphabets used by Flickr, Bitcoin and GMP. The Flickr alphabet is the default and used when no alphabet is provided.
 
-The Flickr implementation uses the [0-9a-zA-Z] Base62 alphabet excluding [0OIl] to improve human readability and is described here:
+Flickr Alphabet: [0-9a-zA-Z] excluding [0OIl] to improve human readability
 
-http://www.flickr.com/groups/api/discuss/72157616713786392/
+Bitcoin Alphabet: [0-9A-Za-z] excluding [0OIl] to improve human readability
 
-The GMP implementation uses the [0-9A-Za-v] alphabet.
+GMP Alphabet: [0-9A-Za-v]
 
-The encode, decode and md5 methods support an alphabet parameter which can be set to 'gmp' to indicate the value to be encoded or decoded.
+The encode, decode and md5 methods support an alphabet parameter which can be set to the supported alphabets ['bitcoin', 'flickr', 'gmp'] to indicate the value to be encoded or decoded.
 
 === GMP
 
 This class requires GMP 4.2.0 or above. Prior versions are limited to Base36.
 
+== Links
+
+Flickr post introducing Base58:
+
+http://www.flickr.com/groups/api/discuss/72157616713786392/
+
+Bitcoin wiki Base58 article:
+
+https://en.bitcoin.it/wiki/Base58Check_encoding
+
 == Problems, Comments, Suggestions?
 
 All of the above are most welcome. mailto:johncwang@gmail.com

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/base58_gmp.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'base58_gmp'
-  s.version     = '0.0.6'
-  s.date        = '2011-11-14'
+  s.version     = '0.0.7'
+  s.date        = '2011-11-21'
   s.summary     = 'High speed Base58 encoding using GMP with MD5 support'
-  s.description = 'Base58 encoding using the GNU Multiple Precision Arithmetic Library (GMP)'
+  s.description = 'High speed Base58 encoding using GMP with MD5 support and transcoding between Flickr, Bitcoin and GMP alphabets.'
   s.authors     = ['John Wang']
   s.email       = 'johncwang@gmail.com'
   s.homepage    =
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
      'lib/base58_gmp.rb',
      'test/test_base58_gmp.rb',
      'test/test_encode-decode-multi.rb',
-     'test/test_flickr-gmp.rb'
+     'test/test_alphabets.rb'
   ]
 
 end

data/lib/base58_gmp.rb

@@ -9,53 +9,68 @@ require 'gmp'
 
 class Base58GMP
 
-  ALPHABET_GMP     = '0-89A-JK-XYZa-fg-kl-v'
-  ALPHABET_FLICKR  = '1-9ab-km-zABC-HJ-NP-Z'
+  ALPHABETS   = {
+    'bitcoin' => '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
+    'flickr'  => '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ',
+    'gmp'     => '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuv'
+  }
+  
   DEFAULT_ALPHABET = 'flickr'
+  GMP_ALPHABET     = 'gmp'
 
-  def self.number_to_base58(number, alphabet=DEFAULT_ALPHABET)
-    base58 = number.is_a?(GMP::Z)     ?
-               number.to_s(base = 58) :
-               GMP::Z(number).to_s(base = 58)
+  def self.integer_to_base58(integer, alphabet=DEFAULT_ALPHABET)
+    base58 = integer.is_a?(GMP::Z)     ?
+               integer.to_s(base = 58) :
+               GMP::Z(integer).to_s(base = 58)
 
-    alphabet.is_a?(String) && alphabet.downcase == 'gmp' ?
+    alphabet.is_a?(String) && alphabet.downcase == GMP_ALPHABET ?
       base58 :
-      self.gmp_to_flickr(base58)
+      from_to(base58, GMP_ALPHABET, alphabet)
   end
 
-  def self.base58_to_number(base58, alphabet=DEFAULT_ALPHABET)
-    if !base58.is_a?(String)
+  def self.base58_to_integer(base58, alphabet=DEFAULT_ALPHABET)
+    unless base58.is_a?(String)
       raise ArgumentError, 'Base58 argument is not a string.'
     end
 
-    unless alphabet.is_a?(String) && alphabet.downcase == 'gmp'
-      base58 = self.flickr_to_gmp(base58)
+    unless alphabet.is_a?(String) && alphabet.downcase == GMP_ALPHABET
+      base58 = from_to(base58, alphabet, GMP_ALPHABET)
     end
 
     GMP::Z.new(base58, 58)
   end
 
-  def self.gmp_to_flickr(base58)
-    if !base58.is_a?(String)
+  def self.from_to(base58, from_alphabet, to_alphabet)
+    unless base58.is_a?(String)
       raise ArgumentError, 'Base58 argument is not a string.'
     end
-    base58 = base58.tr(ALPHABET_GMP, ALPHABET_FLICKR)
-  end
 
-  def self.flickr_to_gmp(base58)
-    if !base58.is_a?(String)
-      raise ArgumentError, 'Base58 argument is not a string.'
+    unless (
+      from_alphabet.is_a?(String) &&
+      from_digits = ALPHABETS[from_alphabet.downcase]
+    )
+      raise ArgumentError, 'From encoding is not valid.'
     end
-    base58 = base58.tr(ALPHABET_FLICKR, ALPHABET_GMP)
+
+    unless (
+      to_alphabet.is_a?(String) &&
+      to_digits = ALPHABETS[to_alphabet.downcase]
+    )
+      raise ArgumentError, 'To encoding is not valid.'
+    end
+
+    from_digits != to_digits ?
+      base58.tr(from_digits, to_digits) :
+      base58
   end
 
   def self.md5_base58(data, alphabet=DEFAULT_ALPHABET)
-    self.number_to_base58(Digest::MD5.hexdigest(data).hex, alphabet)
+    integer_to_base58(Digest::MD5.hexdigest(data).hex, alphabet)
   end
 
   class << self
-    alias_method :encode, :number_to_base58
-    alias_method :decode, :base58_to_number
+    alias_method :encode, :integer_to_base58
+    alias_method :decode, :base58_to_integer
     alias_method :md5, :md5_base58
   end
 

data/test/test_alphabets.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'base58_gmp'
+
+class TestBase58GMP < Test::Unit::TestCase
+  ALPHABETS   = {
+    'bitcoin' => '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
+    'flickr'  => '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ',
+    'gmp'     => '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuv'
+  }
+
+  def test_alphabets_transcoding
+    assert_equal ALPHABETS['bitcoin'], Base58GMP.from_to(ALPHABETS['flickr'], 'flickr', 'bitcoin')
+    assert_equal ALPHABETS['bitcoin'], Base58GMP.from_to(ALPHABETS['gmp'], 'gmp', 'bitcoin')
+    assert_equal ALPHABETS['flickr'], Base58GMP.from_to(ALPHABETS['bitcoin'], 'bitcoin', 'flickr')
+    assert_equal ALPHABETS['flickr'], Base58GMP.from_to(ALPHABETS['gmp'], 'gmp', 'flickr')
+    assert_equal ALPHABETS['gmp'], Base58GMP.from_to(ALPHABETS['bitcoin'], 'bitcoin', 'gmp')
+    assert_equal ALPHABETS['gmp'], Base58GMP.from_to(ALPHABETS['flickr'], 'flickr', 'gmp')
+  end
+
+  def test_alphabets_digits
+    ['gmp'].each { |alphabet|
+      digits = ALPHABETS[alphabet].to_s.split('')
+      (0..57).to_a.each { |decimal|
+        assert_equal digits[decimal].to_s, Base58GMP.encode(decimal,alphabet)
+        assert_equal decimal.to_i, Base58GMP.decode(digits[decimal].to_s, alphabet).to_i
+      }
+   }
+  end
+end

data/test/test_base58_gmp.rb

@@ -506,13 +506,13 @@ INTEGER_EXAMPLES =  { "6hKMCS" => 3471391110,
 
   def test_integer_to_base58
     INTEGER_EXAMPLES.each do |expected, integer|
-      assert_equal expected, Base58GMP.number_to_base58(integer)
+      assert_equal expected, Base58GMP.integer_to_base58(integer)
     end
   end  
 
   def test_base58_to_integer
     INTEGER_EXAMPLES.each do |base58, expected|
-      assert_equal expected, Base58GMP.base58_to_number(base58).to_i
+      assert_equal expected, Base58GMP.base58_to_integer(base58).to_i
     end
   end  
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: base58_gmp
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - John Wang
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-14 00:00:00 -08:00
+date: 2011-11-21 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Base58 encoding using the GNU Multiple Precision Arithmetic Library (GMP)
+description: High speed Base58 encoding using GMP with MD5 support and transcoding between Flickr, Bitcoin and GMP alphabets.
 email: johncwang@gmail.com
 executables: []
 
@@ -37,7 +37,7 @@ files:
 - lib/base58_gmp.rb
 - test/test_base58_gmp.rb
 - test/test_encode-decode-multi.rb
-- test/test_flickr-gmp.rb
+- test/test_alphabets.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/base58_gmp
 licenses: []

data/test/test_flickr-gmp.rb

@@ -1,18 +0,0 @@
-require 'test/unit'
-require 'base58_gmp'
-
-class TestBase58GMP < Test::Unit::TestCase
-
-  ALPHABETS =  {
-    '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuv' =>
-    '123456789abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ'
-  }
-
-  def test_flickr_gmp_transcoding
-    ALPHABETS.each do |gmp, flickr|
-      assert_equal gmp, Base58GMP.flickr_to_gmp(flickr)
-      assert_equal flickr, Base58GMP.gmp_to_flickr(gmp)
-    end
-  end  
-
-end