base58_gmp 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 0.0.4
+- Add flickr_to_gmp transcoding
+- Document Flickr and GMP transcoding
+
 = 0.0.3
 - Minor fixes.
 

data/README.rdoc

@@ -1,12 +1,12 @@
 = Base58GMP
 
-High speed Base58 encoding using GMP with MD5 support
+High speed Base58 encoding using GMP with MD5 support and transcoding between GMP and Flickr implementations.
 
 == Installation
 
 === Gem Installation
 
-Download and install base58_gmp with the following. 
+Download and install base58_gmp with the following:
 
   gem install base58_gmp
 
@@ -16,13 +16,35 @@ Download and install base58_gmp with the following.
   require 'base58_gmp'
   
   # Int to Base58
-  Base58GMP.encode(12345) # => 4ER
-  
+  Base58GMP.encode(12345)      # => 4ER
+
   # 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
+
 == Notes
 
+=== Base58 Implementations - Flickr and GMP
+
+This class supports the Base58 implementations used by Flickr and GMP.
+
+The Flickr implementation uses the [0-9a-zA-Z] Base62 alphabet excluding [0OIl] to improve human readability and is described here:
+
+http://www.flickr.com/groups/api/discuss/72157616713786392/
+
+The GMP implementation uses the [0-9A-Za-v] alphabet.
+
+The encode and md5 functions use the Flickr implementation which can be converted to the GMP implementation using flickr_to_gmp.
+
+=== GMP
+
+This class requires GMP 4.2.0 or above. Prior versions are limited to Base36.
+
+=== Base58 Decoding Support
+
 GMP-supported Base58 decoding is not currently provided as underlying support is not yet available in the Ruby GMP binding.
 
 For now, please use the base58 gem for Ruby-based decoding.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/base58_gmp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'base58_gmp'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.date        = '2011-11-06'
   s.summary     = 'High speed Base58 encoding using GMP with MD5 support'
   s.description = 'Base58 encoding using the GNU Multiple Precision Arithmetic Library (GMP)'

data/lib/base58_gmp.rb

@@ -9,12 +9,15 @@ class Base58GMP
 
   def self.number_to_base58( number )
     base58 = GMP::Z( number ).to_s( base = 58 )
-    base58 = self.gmp_to_flickr( base58 )
-    base58
+    self.gmp_to_flickr( base58 )
   end
 
   def self.gmp_to_flickr( base58_as_gmp )
-    base58 = base58_as_gmp.tr( ALPHABET_GMP, ALPHABET_FLICKR )
+    base58_as_gmp.tr( ALPHABET_GMP, ALPHABET_FLICKR )
+  end
+
+  def self.flickr_to_gmp( base58_as_flickr )
+    base58_as_flickr.tr( ALPHABET_FLICKR, ALPHABET_GMP )
   end
 
   def self.md5_base58( data )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: base58_gmp
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - John Wang