zimmermann-base32 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b816e31f911d2e3707a000a90582a06c341aec86
+  data.tar.gz: 84cfe896d86c429a8ac2e9329f669c6d3184262e
+SHA512:
+  metadata.gz: d777a469e2f3f770f87fa5216857d176e11fd95a0469205be5eb6d7ed44519ca539c66d91338b6c6b1be72a0947b7bc6c461e6f77ea563c1555305f151edc196
+  data.tar.gz: 0606c7b44cf20fab6c0e868cdeeadca3e5e470df23e1e76c5f98540f083a592b39e4cfd27f25ab79cb4dd00ea66125d1f143f8de054666ed10839be084b6a581

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.3.0
+after_succes:
+  - coveralls

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify gem dependencies in gemspec file
+gemspec
+
+# Point to repo
+group :test do
+  gem "rantly", github: "hayeah/rantly"
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GIT
+  remote: git://github.com/hayeah/rantly.git
+  revision: edd7289d26171ad6aa9d03e0e4fb67091c09798d
+  specs:
+    rantly (0.3.2)
+
+PATH
+  remote: .
+  specs:
+    zimmermann-base32 (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    docile (1.1.5)
+    json (1.8.3)
+    minitest (5.8.4)
+    rake (10.5.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  coveralls (~> 0.7)
+  minitest (~> 5)
+  rake (~> 10.3)
+  rantly!
+  zimmermann-base32!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Phillips
+
+MIT License
+
+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.md

@@ -0,0 +1,27 @@
+# Zimmerman Base32
+
+[![Build
+Status](https://travis-ci.org/jamesdphillips/mailgat.svg)](https://travis-ci.org/jamesdphillips/zimmermann-base32)
+[![Coverage
+Status](https://coveralls.io/repos/jamesdphillips/mailgat/badge.png?branch=master)](https://coveralls.io/r/jamesdphillips/zimmermann-base32?branch=master)
+
+_Fork of @paulstefanort's Ruby ZBase32 implementation._
+
+zbase32 is a Base32 spec with an is an easy-to-remember and unambiguous alphabet.
+
+## Usage
+
+```ruby
+encoder   = ZBase32.new
+my_string = "I like cakes."
+encoded32 = encoder.encode(my_string) # "jneaswppfdegsoppf5hhn"
+encoder.decode(encoded32)             # "I like cakes."
+```
+
+## Contributing
+
+TODO
+
+## Developement
+
+TODO

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+#
+# Gems
+
+begin
+  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
+
+#
+# Tests
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+#
+# Default to running tests
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/zbase32.rb

@@ -0,0 +1,73 @@
+module ZBase32
+  CHARSET = %w( y b n d r f g 8 e j k m c p q x o t 1 u w i s z a 3 4 5 h 7 6 9 ).freeze
+  MASKS   = [0x1f, 0x3e, 0x7c, 0xf8, 0xf0, 0xe0, 0xc0, 0x80].freeze
+  MASKS2  = [0x1, 0x3, 0x7, 0xf].freeze
+  ZB2N = CHARSET.each_with_index.inject({}) { |acc, (a, b)| acc[a] = b; acc }.freeze
+
+  extend self
+
+  def encode(bytes)
+    ret = ""
+    (split_string(bytes)).each do |part|
+      raise "There is no #{part}" unless part < 32
+      ret = ret + CHARSET[part]
+    end
+    ret
+  end
+
+  def decode(bytes)
+    join_string(bytes.downcase.split('').map { |s| ZB2N[s] })
+  end
+
+  private
+
+  def split_string string
+    output    = [] ; chunk  = 0
+    part      = 0  ; offset = 0
+    suboffset = 0  ; q      = 0
+    length    = 8 * string.length
+
+    while (q < length) do
+      offset = (q / 8).to_i
+      suboffset = q % 8
+      part = string[offset, 1][0].ord
+      chunk = (part & MASKS[suboffset]) >> suboffset
+      suboffset = suboffset - 4
+      if suboffset >= 0
+        if ((q + 5) > length)
+          part = 0
+        else
+          part = string[offset+1, 1][0].ord
+        end
+        chunk |= (part & MASKS2[suboffset]) << (4 - suboffset)
+      end
+      output.push chunk
+      q = q + 5
+    end
+    output
+  end
+
+  def join_string output
+    length    = 5 * output.size
+    ret       = Array.new((length / 8.0).ceil, 0)
+    part      = 0  ; chunk  = 0
+    suboffset = 0  ; offset = 0
+    n         = 0  ; q      = 0
+    while (q < length) do
+      offset = (q / 8).to_i
+      suboffset = q % 8
+      part = output[n]
+      chunk = (part << suboffset ) & MASKS[suboffset]
+      ret[offset] |= chunk
+      suboffset = suboffset - 4
+      if suboffset >= 0
+        ret[offset+1] |= (part >> (4-suboffset) ) & MASKS2[suboffset]
+      end
+      n = n + 1
+      q = q + 5
+    end
+    string = ret.map(&:chr).join('')
+    string.chomp!("\0")
+    string
+  end
+end

data/lib/zbase32/version.rb

@@ -0,0 +1,3 @@
+module ZBase32
+  VERSION = '0.1.0'.freeze
+end

data/test/base32_test.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+require "zbase32"
+require "rantly/shrinks"
+
+describe ZBase32 do
+  before do
+    Rantly.gen.reset
+  end
+
+  it "only returns encoded string within charset" do
+    str = Rantly { sized(25) {string} }
+    out = ZBase32.encode(str)
+    assert(out.match(/[^#{ZBase32::CHARSET.map(&:to_s)}]+/).nil?)
+  end
+
+  it "encodes very long strings" do
+    str = Rantly { sized(25000) {string} }
+    out = ZBase32.encode(str)
+    assert(out.size > 25000)
+    assert_equal(ZBase32.decode(out), str)
+  end
+
+  it "handles non-ascii characters" do
+    num = Rantly.map(1) { integer }.pack("N")
+    out = ZBase32.encode(num)
+    assert(out.size > 5)
+    assert_equal(ZBase32.decode(out), num)
+  end
+
+  # This is probably the wrong way to be using Rantly..
+  it "despite input length returns decodable output" do
+    Rantly { array(250) { sized(80) {string} } }.each do |string|
+      while string.shrinkable? do
+        output = ZBase32.decode(ZBase32.encode(string))
+        assert_equal output, string
+        string = string.shrink
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+require "minitest/autorun"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "simplecov"
+SimpleCov.start
+
+begin
+  # Coveralls is marked as an _optional_ dependency, so don't
+  # throw a fit if it's not there.
+  require "coveralls"
+  Coveralls.wear!
+rescue LoadError
+end
+
+require "rantly"
+require "rantly/minitest_extensions"

data/zimmermann-base32.gemspec

@@ -0,0 +1,30 @@
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require 'zbase32/version'
+
+Gem::Specification.new do |s|
+  s.name = "zimmermann-base32"
+  s.summary = "Zimmermann's Base32"
+  s.description = "Implements ZBase32; an easy to remember and unambiguous Base32 charset."
+  s.version = ZBase32::VERSION
+  s.homepage = "https://www.github.com/jamesdphillips/zimmermann-base32"
+  s.license = "MIT"
+  s.email = ["jamesdphillips@gmail.com"]
+
+  # Orginally authored by pso
+  s.authors = ["pso", "James Phillips"]
+
+  # Only tested on 2.2+
+  s.required_ruby_version = Gem::Requirement.new(">= 2.2.0")
+
+  # Files
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  # Deps
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "coveralls", "~> 0.7"
+  s.add_development_dependency "rake", "~> 10.3"
+  s.add_development_dependency "minitest", "~> 5"
+  # s.add_development_dependency "rantly" # in Gemfile
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: zimmermann-base32
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pso
+- James Phillips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Implements ZBase32; an easy to remember and unambiguous Base32 charset.
+email:
+- jamesdphillips@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/zbase32.rb
+- lib/zbase32/version.rb
+- test/base32_test.rb
+- test/test_helper.rb
+- zimmermann-base32.gemspec
+homepage: https://www.github.com/jamesdphillips/zimmermann-base32
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Zimmermann's Base32
+test_files:
+- test/base32_test.rb
+- test/test_helper.rb
+has_rdoc: