fixed_length_encoder 0.0.1 → 1.0.0

data/lib/fixed_length_encoder.rb

@@ -1,25 +1,70 @@
-class FixedLengthEncoder
-  ALPHABET = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-  BASE = ALPHABET.length
-
-  def self.encode(value, length = 8)
-    raise ArgumentError, 'Cannot encode a non-Integer.' unless value.is_a?(Integer)
-    message = ''
-    while (value > 0)
-      remainder = value % BASE
-      message += ALPHABET[remainder]
-      value = (value - remainder)/BASE
-    end
-    message
+module FixedLengthEncoder
+  ALPHABET = 'QkzHJPxlXtZrTYjiIV482CuqMOBocsEDLa5vhWfb6Ke1NGS9RUyd70nF3gmpwA'
+  LENGTH = 8
+
+  def self.encode(value, message_length = nil)
+    message_length = LENGTH if message_length.nil?
+    encoder = FixedLengthEncoder::Encoder.new(ALPHABET)
+    encoder.encode(value, message_length)
   end
 
   def self.decode(message)
-    value = 0
-    message.reverse.split('').each do |digit|
-      index = ALPHABET.index(digit)
-      raise ArgumentError, 'Invalid character' if index.nil?
-      value = (value * BASE) + index
+    encoder = FixedLengthEncoder::Encoder.new(ALPHABET)
+    encoder.decode(message)
+  end
+
+  class Encoder
+    def initialize(alphabet)
+      @alphabet = alphabet
+    end
+
+    def setup(message_length)
+      @message_length = message_length
+      @max_message_value = (@alphabet.length)**message_length
+      @max_bits = Math::log(@max_message_value, 2).floor
+      @max_value = 2**@max_bits
+    end
+
+    def encode(value, message_length)
+      raise ArgumentError, 'Cannot encode a non-integer.' unless value.is_a?(Integer)
+      self.setup(message_length)
+      raise ArgumentError, "Cannot encode #{value} in #{@message_length} characters" if value > @max_value
+      value = self.scramble_value(value, @max_bits)
+      self.integer_to_string(@alphabet, value, @message_length)
+    end
+
+    def integer_to_string(alphabet, value, message_length)
+      message = ''
+      base = alphabet.length
+      while (value > 0 || message.length < message_length)
+        remainder = value % base
+        message += alphabet[remainder]
+        value = (value - remainder)/base
+      end
+      message
+    end
+
+    def decode(message)
+      raise ArgumentError, 'Cannot decode a non-string.' unless message.is_a?(String)
+      self.setup(message.length)
+      value = self.string_to_integer(@alphabet, message)
+      self.scramble_value(value, @max_bits)
+    end
+
+    def string_to_integer(alphabet, message)
+      base = alphabet.length
+      value = 0
+      message.reverse.split('').each do |digit|
+        index = alphabet.index(digit)
+        raise ArgumentError, 'Cannot decode an invalid character (' + digit + ')' if index.nil?
+        value = (value * base) + index
+      end
+      value
+    end    
+
+    def scramble_value(value, bits)
+      binary = self.integer_to_string('10', value, bits).reverse
+      self.string_to_integer('01', binary)
     end
-    value
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixed_length_encoder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies: []
-description: Integers are converted to 6 or 8 digit strings using a binary reversal
-  and a shuffled base 62 alphabet.  Strings with valid digits (0-9 a-z A-z)are converted
-  back to integers.  The encoding is one-to-one but not sequential.This is useful
-  for obfuscating user ids in urls.
+description: Integers are converted to strings using a binary reversal and a shuffled
+  base 62 alphabet.  Strings with valid digits (0-9 a-z A-z)are converted back to
+  integers.  The encoding is one-to-one but not sequential.This is useful for obfuscating
+  user ids in urls.
 email: brett@paperyfrog.com
 executables: []
 extensions: []
@@ -44,5 +44,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Two way conversion from integer to a fixed 6 or 8 digit string.
+summary: Two way conversion from integer to a fixed (default=8) digit string.
 test_files: []