base32h 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de7e1abc9f5fbb560cd132ff8c7d11c0c8c91e3b751d2031988de46cc3072b7b
+  data.tar.gz: 734e6651e89a697c7d8faeee81351a235a2d3473215e027cd7b7cae1897685d6
+SHA512:
+  metadata.gz: 2022dfbdefa1e442441a68118e1cc82a497f75f703e23f98b0078a6c93f482225ce21fc66388e826f76d6aa47b7401ae69075b43ce59d40837664a0aab1ecd68
+  data.tar.gz: 93b45da982c68477c84ff31ec3926038c24f26d1b1fb7aa94551b50bcf17a79f9e48099e4f1a10f334b20df25ca78dcecf89b725fe28549d8447cf7d8b9edc95

data/COPYING

@@ -0,0 +1,14 @@
+Copyright (c) 2020 Ryan S. Northrup ("RyNo") <northrup@yellowapple.us>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# `base32h.rb`
+
+## What is it?
+
+It's the third reference implementation of an encoder and decoder for
+Base32H, a new(-ish) duotrigesimal (that is: base-32) number
+representation, written as a gem for Ruby.
+
+## How do I install it?
+
+Run `gem install base32h`, or include it in your `Gemfile`, or
+whatever you would normally do to install a gem.
+
+## How do I hack it?
+
+```bash
+git clone --recursive https://github.com/base32h/base32h.rb.git
+cd base32h.rb
+rspec  # to run the test suite
+```
+
+## How do I use it?
+
+```ruby
+require 'base32h'
+
+Base32H.encode 17854910
+# => "H0WDY"
+
+Base32H.encode_bin "\xE3\xA9H\x83\x8D\xF5\xD5\x96\xD9\xD9"
+# => "WELLH0WDYPARDNER"
+
+Base32H.decode '88pzd'
+# => 8675309
+
+Base32H.decode_bin('2060w2g6009').unpack('C*')
+# => [0, 0, 0, 8, 6, 7, 5, 3, 0, 9]
+```
+
+## Am I allowed to use it?
+
+Yep!  Just follow the terms of the ISC license (see `COPYING` in this repo).

data/lib/base32h.rb

@@ -0,0 +1,173 @@
+##
+# This module provides Base32H encoding and decoding functions.
+module Base32H
+  VERSION = "0.1.0"
+  
+  extend self
+
+  ##
+  # The complete list of Base32H digits, as an array of strings; the
+  # index of the array is the numeric value of the digit(s) in the
+  # string at that index.  The first character in each string is the
+  # "canonical" digit (i.e. the one that Base32H-conformant encoders
+  # *must* emit for that value); all other characters (if present) are
+  # "aliases" (i.e. alternate forms of that digit that
+  # Base32H-conformant decoders *must* accept and correctly decode to
+  # that value).
+  #
+  # For example, +digits[27]+ returns +'VvUu'+, meaning that the
+  # "canonical" digit of value 27 is +V+, and that +v+, +U+, and +u+
+  # are all "aliases" of that canonical digit and decode to a value of
+  # 27.
+  def digits
+    ['0Oo',
+     '1Ii',
+     '2',
+     '3',
+     '4',
+     '5Ss',
+     '6',
+     '7',
+     '8',
+     '9',
+     'Aa',
+     'Bb',
+     'Cc',
+     'Dd',
+     'Ee',
+     'Ff',
+     'Gg',
+     'Hh',
+     'Jj',
+     'Kk',
+     'Ll',
+     'Mm',
+     'Nn',
+     'Pp',
+     'Qq',
+     'Rr',
+     'Tt',
+     'VvUu',
+     'Ww',
+     'Xx',
+     'Yy',
+     'Zz']
+  end
+
+  ##
+  # :category: Encoding Digit
+  #
+  # Encodes an integer between 0 and 31 (inclusive) to its Base32H
+  # representation.
+  def encode_digit(d)
+    d = d.to_i
+    return nil unless (0..31).include? d
+    digits[d][0]
+  end
+
+  ##
+  # :category: Encoding Numeric
+  #
+  # Encodes an integer to its Base32H representation.
+  def encode(int)
+    rem = int.to_i.abs
+    out = []
+    return '0' if rem == 0
+    while rem > 0 do
+      out.unshift(encode_digit(rem % 32))
+      rem /= 32
+    end
+    out.join ''
+  end
+
+  ##
+  # :category: Encoding Binary
+  #
+  # Encodes a (binary) string to its Base32H representation.
+  def encode_bin(bin)
+    data = bin.unpack('C*')
+    extra = data.length % 5
+    data = ([0] * (5 - extra)) + data if extra > 0
+    out = []
+    data.each_slice(5) do |s|
+      chunk = bytes_to_u40 s
+      out.push encode(chunk).rjust(8, '0')
+    end
+    out.join ''
+  end
+
+  ##
+  # :category: Decoding Digit
+  #
+  # Decodes a single Base32H digit to its integer representation.
+  def decode_digit(d)
+    d = d.to_s
+    digits.find_index {|i| i.include? d}
+  end
+
+  ##
+  # :category: Decoding Numeric
+  #
+  # Decodes a Base32H number to its integer representation.
+  def decode(str)
+    res = str.to_s.chars.reverse.reduce({acc: 0, exp: 0}) do |state, char|
+      digit = decode_digit(char)
+      if digit.nil?
+        state
+      else
+        {acc: state[:acc] + (digit * 32**state[:exp]),
+         exp: state[:exp] + 1}
+      end
+    end
+    res[:acc]
+  end
+
+  ##
+  # :category: Decoding Binary
+  #
+  # Decodes a Base32H binary into a string of packed unsigned bytes.
+  def decode_bin(str)
+    data = str.chars.reject {|c| decode_digit(c).nil?}
+    extra = data.length % 8
+    data = (['0'] * (8 - extra)) + data if extra > 0
+    out = []
+    data.each_slice(8) do |s|
+      chunk = u40_to_bytes decode(s.join '')
+      out += chunk
+    end
+    out.pack('C*')
+  end
+
+  private
+
+  def u40_to_bytes(int)
+    rem = int.to_i.abs
+    out = []
+    while rem > 0 do
+      out.unshift(rem % 256)
+      rem /= 256
+    end
+    pad = 5 - out.length
+    out = ([0] * pad) + out if pad > 0
+    out
+  end
+
+  def bytes_to_u40(bytes)
+    bytes.reverse.reduce({acc:0,exp:0}) do |s,b|
+      {acc: s[:acc] + (b * 2**(8*s[:exp])),
+       exp: s[:exp] + 1}
+    end[:acc]
+  end
+end
+
+class Integer
+  def to_base32h
+    Base32H.encode(self)
+  end
+end
+
+class String
+  def to_base32h
+    Base32H.encode_bin(self)
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: base32h
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan S. Northrup ("RyNo")
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An encoder/decoder library for Base32H
+email: northrup@yellowapple.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- README.md
+- lib/base32h.rb
+homepage: https://base32h.github.io
+licenses:
+- ISC
+metadata:
+  homepage_uri: https://base32h.github.io
+  source_code_uri: https://github.com/base32h/base32h.rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Base32H
+test_files: []