base32 0.2.0 → 0.3.0

data/.gitignore

@@ -0,0 +1,5 @@
+ext/Makefile
+ext/*.o
+ext/*.so
+ext/*.bundle
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## 0.3.0
+
+- Add `Base32::random_base32` function
+- Add test cases for hexadecimal conversion
+- Upgrade tests to use Minitest (successor to Test::Unit)
+- Add Travis and CodeClimate badges to README
+- Add Gemfile and gemspec files, using `gem-release` gem to release
+- Track version as a Ruby constant
+
+## 0.2.0 and prior
+
+- Support Base32::encode/decode methods

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2011 Samuel Tesla
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -1,8 +1,11 @@
 = base32
 
+{<img src="https://travis-ci.org/stesla/base32.png" />}[https://travis-ci.org/stesla/base32]
+{<img src="https://codeclimate.com/github/stesla/base32.png" />}[https://codeclimate.com/github/stesla/base32]
+
 For Version: 0.1.3
 
-This package contains base32, a ruby extension for encoding and decoding
+This package contains base32, a Ruby extension for encoding and decoding
 in base32 per RFC 3548.
 
 == Download

data/Rakefile

@@ -1,53 +1,19 @@
-# Copyright (c) 2007-2011 Samuel Tesla
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+begin
+  require 'bundler'
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
 
-require File.join(File.dirname(__FILE__), 'config', 'environment.rb')
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/testtask'
+require 'bundler/gem_tasks'
 require 'rubygems'
+require 'rake/testtask'
 
-task :default => ['test:all']
-
-gemspec = Gem::Specification.new do |s|
-  s.author = "Samuel Tesla"
-  s.email = "samuel.tesla@gmail.com"
-  s.extra_rdoc_files = ["README"]
-  s.files = FileList["Rakefile", "{config,lib,test}/**/*"]
-  s.has_rdoc = true
-  s.name = 'base32'
-  s.require_paths << 'lib'
-  s.requirements << 'none'
-  s.summary = "Ruby extension for base32 encoding and decoding"
-  s.version = "0.2.0"
-end
-
-Rake::GemPackageTask.new(gemspec) do |pkg|
-  pkg.need_tar = true
-end
+task :default => :test
 
-namespace :test do
-  Rake::TestTask.new :all do |t|
-    t.libs << 'test'
-    t.pattern = 'test/**/*_test.rb'
-    t.verbose = true
-  end
-  Rake::Task['test:all'].comment = 'Run all of the tests'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
 end

data/base32.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'version'
+
+Gem::Specification.new do |s|
+  s.name    = 'base32'
+  s.version = Base32::VERSION
+  s.authors = ['Samuel Tesla']
+  s.email   = 'samuel.tesla@gmail.com'
+  s.summary = 'Ruby extension for base32 encoding and decoding'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README']
+
+  s.post_install_message = File.read('UPGRADING') if File.exists?('UPGRADING')
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'gem-release'
+end

data/lib/base32.rb

@@ -1,5 +1,8 @@
+require 'openssl'
+
+# Module for encoding and decoding in Base32 per RFC 3548
 module Base32
-  TABLE = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"
+  TABLE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'.freeze
 
   class Chunk
     def initialize(bytes)
@@ -10,15 +13,15 @@ module Base32
       bytes = @bytes.take_while {|c| c != 61} # strip padding
       n = (bytes.length * 5.0 / 8.0).floor
       p = bytes.length < 8 ? 5 - (n * 8) % 5 : 0
-      c = bytes.inject(0) {|m,o| (m << 5) + TABLE.index(o.chr)} >> p
+      c = bytes.inject(0) {|m,o| (m << 5) + Base32.table.index(o.chr)} >> p
       (0..n-1).to_a.reverse.collect {|i| ((c >> i * 8) & 0xff).chr}
     end
-    
+
     def encode
       n = (@bytes.length * 8.0 / 5.0).ceil
       p = n < 8 ? 5 - (@bytes.length * 8) % 5 : 0
       c = @bytes.inject(0) {|m,o| (m << 8) + o} << p
-      [(0..n-1).to_a.reverse.collect {|i| TABLE[(c >> i * 5) & 0x1f].chr},
+      [(0..n-1).to_a.reverse.collect {|i| Base32.table[(c >> i * 5) & 0x1f].chr},
        ("=" * (8-n))]
     end
   end
@@ -32,7 +35,7 @@ module Base32
     end
     result
   end
-  
+
   def self.encode(str)
     chunks(str, 5).collect(&:encode).flatten.join
   end
@@ -40,4 +43,25 @@ module Base32
   def self.decode(str)
     chunks(str, 8).collect(&:decode).flatten.join
   end
+
+  def self.random_base32(length=16)
+    random = ''
+    OpenSSL::Random.random_bytes(length).each_byte do |b|
+      random << self.table[b % 32]
+    end
+    random.ljust((length / 8.0).ceil * 8, '=') # add padding
+  end
+
+  def self.table=(table)
+    raise ArgumentError, "Table must have 32 unique characters" unless self.table_valid?(table)
+    @table = table
+  end
+
+  def self.table
+    @table || TABLE
+  end
+
+  def self.table_valid?(table)
+    table.bytes.size == 32 && table.bytes.uniq.size == 32
+  end
 end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Base32
+  VERSION = '0.3.0'
+end

data/test/base32_test.rb

@@ -1,27 +1,8 @@
-# Copyright (c) 2007-2011 Samuel Tesla
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'test/unit'
-require 'base32'
-
-class TestBase32 < Test::Unit::TestCase
+gem 'minitest'
+require 'minitest/autorun'
+require File.dirname(__FILE__) + '/../lib/base32.rb'
+
+class TestBase32 < Minitest::Test
   def assert_decoding(encoded, plain)
     decoded = Base32.decode(encoded)
     assert_equal(plain, decoded)
@@ -37,6 +18,11 @@ class TestBase32 < Test::Unit::TestCase
     assert_decoding(encoded, plain)
   end
 
+  def assert_hex_encode_and_decode(encoded, hex)
+    plain = [hex].pack('H*')
+    assert_encode_and_decode(encoded, plain)
+  end
+
   def test_empty_string
     assert_encode_and_decode('', '')
   end
@@ -72,4 +58,59 @@ class TestBase32 < Test::Unit::TestCase
       N5XAUIBAEAQCAIDGN5ZCA5DIMUQFK3TJORSWIICTORQXIZLTEBXWMICBNVSXE2LDMEXAU===).join
     assert_encode_and_decode(encoded, plaintext)
   end
+
+  def test_hex_byte_encoding
+    assert_hex_encode_and_decode('FA======', '28')
+    assert_hex_encode_and_decode('2Y======', 'd6')
+    assert_hex_encode_and_decode('234A====', 'd6f8')
+    assert_hex_encode_and_decode('234AA===', 'd6f800')
+    assert_hex_encode_and_decode('234BA===', 'd6f810')
+    assert_hex_encode_and_decode('234BCDA=', 'd6f8110c')
+    assert_hex_encode_and_decode('234BCDEA', 'd6f8110c80')
+    assert_hex_encode_and_decode('234BCDEFGA======', 'd6f8110c8530')
+    assert_hex_encode_and_decode('234BCDEFG234BCDEFE======', 'd6f8110c8536b7c0886429')
+  end
+
+  def test_random_base32
+    assert_equal(16, Base32.random_base32.length)
+    assert_match(/^[A-Z2-7]+$/, Base32.random_base32)
+  end
+
+  def test_random_base32_length
+    assert_equal(32, Base32.random_base32(32).length)
+    assert_equal(40, Base32.random_base32(40).length)
+    assert_equal(32, Base32.random_base32(29).length)
+    assert_match(/^[A-Z2-7]{1}={7}$/, Base32.random_base32(1))
+    assert_match(/^[A-Z2-7]{29}={3}$/, Base32.random_base32(29))
+  end
+
+  def test_assign_new_table
+    new_table =  'abcdefghijklmnopqrstuvwxyz234567'
+    Base32.table = new_table
+    assert_equal(new_table, Base32.table)
+    Base32.table = Base32::TABLE # so as not to ruin other tests
+  end
+
+  def test_check_table_length
+    assert_raises(ArgumentError) { Base32.table = ('a' * 31) }
+    assert_raises(ArgumentError) { Base32.table = ('a' * 32) }
+    assert_raises(ArgumentError) { Base32.table = ('a' * 33) }
+    assert_raises(ArgumentError) { Base32.table = ('abcdefghijklmnopqrstuvwxyz234567' * 2) }
+    Base32.table = Base32::TABLE # so as not to ruin other tests
+  end
+
+  def test_encode_decode_with_alternate_table
+    Base32.table = 'abcdefghijklmnopqrstuvwxyz234567'
+    assert_hex_encode_and_decode('fa======', '28')
+    assert_hex_encode_and_decode('2y======', 'd6')
+    assert_hex_encode_and_decode('234a====', 'd6f8')
+    assert_hex_encode_and_decode('234aa===', 'd6f800')
+    assert_hex_encode_and_decode('234ba===', 'd6f810')
+    assert_hex_encode_and_decode('234bcda=', 'd6f8110c')
+    assert_hex_encode_and_decode('234bcdea', 'd6f8110c80')
+    assert_hex_encode_and_decode('234bcdefga======', 'd6f8110c8530')
+    assert_hex_encode_and_decode('234bcdefg234bcdefe======', 'd6f8110c8536b7c0886429')
+    Base32.table = Base32::TABLE # so as not to ruin other tests
+  end
+
 end

metadata

@@ -1,60 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: base32
-version: !ruby/object:Gem::Version 
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Samuel Tesla
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-12 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
+date: 2014-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: samuel.tesla@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- README
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
 - README
-files: 
 - Rakefile
+- base32.gemspec
 - config/environment.rb
 - lib/base32.rb
+- lib/version.rb
 - test/base32_test.rb
-- README
-has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-- 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: 
-- none
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby extension for base32 encoding and decoding
-test_files: []
-
+test_files:
+- test/base32_test.rb