base64_compatible 0.0.1

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+desc "benchmark"
+task :benchmark do |b|
+  require 'base64'
+  require 'benchmark'
+  require 'lib/base64_compatible'
+  require 'test/strings'
+  include Strings
+
+  n = 5000
+  encoded_login_string = Base64Compatible.encode64(LOGIN_STRING)
+  puts ""
+  Benchmark.bm do |x|
+    x.report("Base64.encode64") { n.times do; Base64.encode64(LOGIN_STRING); end }
+    x.report("Base64Compatible.encode64") { n.times do ; Base64Compatible.encode64(LOGIN_STRING); end }
+    x.report("Base64.decode64") { n.times do; Base64.decode64(encoded_login_string); end }
+    x.report("Base64Compatible.decode64") { n.times do ; Base64Compatible.decode64(encoded_login_string); end }
+  end
+end

data/lib/base64_compatible.rb

@@ -0,0 +1,53 @@
+module Base64Compatible
+  module_function
+  CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/".split ''
+
+  VERSION = "0.0.1"
+
+  # === Encode Non-MIME
+  # convert string to binary
+  # copy groups of 8 bits to 6 bits
+  # add Base64Compatible padding - 0 fill (to 6) the right side of the last bit grouping
+  # add byte padding (1.8 + 1.9 compat)
+  def encode64(string="")
+    encoded, buffer = '', string.unpack('B*')[0]
+    buffer.scan(/.{6}/).each { |nib| encoded << CHARS[nib.to_i(2)] }
+    encoded << CHARS[((buffer[-(buffer.size % 6)..-1] << "00000")[/^(.{6})(.+)/,1]).to_i(2)]
+    (string.send((string.respond_to?(:bytesize) ? :bytesize : :size)) % 4).times { encoded << '=' }
+    encoded
+  end
+
+  # === Decode MIME and non-MIME
+  # iterate string as character array
+  # left pad each 6 bit representation with 0s
+  # lop off trailing 0s (from encoded fill)
+  # covert decoded bits to new character set
+  def decode64(string="")
+    decoded = ""
+    string.unpack('C*').each do |char_num|
+      base64_index = CHARS.index(char_num.chr)
+      decoded << "%06d" % base64_index.to_s(2) if base64_index
+    end
+    (decoded.size % 8).times { decoded.chop! }
+    decoded.gsub!(/(.{8})/) { |b| b.to_i(2).chr }
+  end
+
+  # TODO: Rework placeholders
+  # def strict_encode64(bin)
+  #
+  # end
+  #
+  # def strict_decode64(str)
+  #
+  # end
+
+  # TODO: Replace encode with strict versions to duplicate native lib kaboom
+  def urlsafe_encode64(bin)
+    encode64(bin).tr("+/", "-_")
+  end
+
+  def urlsafe_decode64(str)
+    decode64(str.tr("-_", "+/"))
+  end
+
+end

data/test/base.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'test/unit'
+require 'base64_compatible'

data/test/strings.rb

@@ -0,0 +1,17 @@
+module Strings
+  LOGIN_STRING = "username:password"
+  STRING = "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+  PARAGRAPH = %Q[
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    Fusce dolor massa, tincidunt eu pulvinar id, congue vel lacus.
+    Ut at nisi volutpat elit consequat facilisis.
+    Nam imperdiet fringilla urna, ut ultricies tellus hendrerit sed.
+    Sed eleifend velit ut enim ultrices tincidunt.
+    Cras non eros augue, non posuere nibh. Vivamus sit amet nisl magna, eu blandit ante.
+    Curabitur nec magna eget nibh porttitor congue vel sed felis.
+    Phasellus vitae consectetur purus. Curabitur luctus tortor ac nisl lobortis imperdiet.
+    Integer eu pharetra mi. Aenean luctus nibh et est iaculis vehicula.
+    Nunc dictum accumsan urna, vitae auctor nisl consequat ut. Donec at tortor dolor,
+    varius placerat libero. Donec consequat pulvinar urna, non posuere libero tempor at.
+  ]
+end

data/test/test_coding.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/base'
+require 'strings'
+require 'base64' # compare with
+
+class TC_Base64Compatible < Test::Unit::TestCase
+  include Strings
+
+  def test_encode_and_decode
+    assert_equal LOGIN_STRING, Base64Compatible.decode64(Base64Compatible.encode64(LOGIN_STRING))
+    assert_equal STRING, Base64Compatible.decode64(Base64Compatible.encode64(STRING))
+    assert_equal PARAGRAPH, Base64Compatible.decode64(Base64Compatible.encode64(PARAGRAPH))
+  end
+
+  def test_encode_is_non_mime
+    # \n is a MIME marker
+    assert (Base64Compatible.encode64(PARAGRAPH)[/\n/].nil?)
+    # Base64 encodes mime...verify our output doesn't match
+    assert_not_equal Base64.encode64(PARAGRAPH), Base64Compatible.encode64(PARAGRAPH)
+  end
+
+  # NOTE: Depending on byte alignment, codings can be equal.
+  #       One example is the included STRING test, where PARAGRAPH wouldn't
+  #       show the same result.
+  #       assert_equal PARAGRAPH, Base64.decode64(Base64Compatible.encode64(PARAGRAPH)) #=> true
+  def test_base64_std_lib_fails_decoding_non_mime
+    # Base64 can't decode non-MIME encoded base64
+    assert_not_equal STRING, Base64::decode64(Base64Compatible.encode64(STRING))
+  end
+
+  def test_can_decode_base64_std_lib
+    # decode works on MIME encoded base64
+    assert_equal LOGIN_STRING, Base64Compatible.decode64(Base64.encode64(LOGIN_STRING))
+    assert_equal STRING, Base64Compatible.decode64(Base64.encode64(STRING))
+    assert_equal PARAGRAPH, Base64Compatible.decode64(Base64.encode64(PARAGRAPH))
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: base64_compatible
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alan Da Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Standards compliant port of ruby std lib Base64
+email: alandacosta@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/base64_compatible.rb
+- test/base.rb
+- test/strings.rb
+- test/test_coding.rb
+has_rdoc: true
+homepage: http://github.com/adacosta/base64_compatible
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A non-MIME ruby base64 library
+test_files: []
+