base32-url 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a101ccc7f345bba071066ee065dd335e434fb680
+  data.tar.gz: f0a1e95eeec9110ab4604246a3c2f6dca42ce6af
+SHA512:
+  metadata.gz: 3d156713e87fa7ff31e62a74b066da157deae6199f857f83bf0bcbab15df14204f1fa4b02590d7f7b5801493b04ce54dc9c1e13e041f0272b50ae89861e31874
+  data.tar.gz: 4f8e4d21ea3b6c6aa63b750fc11e6ce17dd5b9c226df5c96466519eea1ee230c131243a4dcfcf3e86dc5625446a36b9d8556f2512db1efa02479a5f7455b2b48

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+doc
+pkg

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+- 2.3.1
+install:
+- travis_retry bundle install
+script: bundle exec rake
+deploy:
+  provider: rubygems
+  api_key:
+    secure: sDQBkoDoHaO4W+HH32585gzQLU9zdfgwm6mT0GgVhD/yODXbFdVgvMkBJ6jocqjq0nKdqEiygMOwWCn60YzuLtFMOTBbqnJkX1FGMsBVU++dr6yQMuROQ9tYqWjBiVFrm4iIOl2dezZdhOCBdwXU43ORXyRmNICmk/V+LWOhSt6HklkJGYmHvw3oOLIDMDllkeKgnnuWGtLX66w2b0Fu42UCZE16Dr12z8V2KoK833yUEjJIoOjC9VKcHsjDv3HzdQXD9yM4gnYxawT0fHUvrRxxA/R/ZWLc8IykUdjDD6CU1fTJxUBwKaxs/Sa3Lv+CyvX86y1c0CYH4FIf39kUg4Dcwdc3+W90t3yUpvIWSBT77oENfS0H3Y4cQXHXQtKC0vox84nR+AMewMOvZ6c4pk65J8ZJjr4hHBV3/kHjeCEGZyDix/QkfwDFEtSPcqtbh8TTn5RLgETCkgrOgppqlXLVkT5qP4kG5shigx1P+g6uNJhWveRKJtVFlyiJvx6mmF4oKkLajnrv58xzqSeUOzyIUyYpkcrqqe5oqzbEhOltD1fxmdsx63PRAHEWPa0afNQIVRboKADL9bGE/8rK3EtKtCHOzdFRWsSVdHOlJK1R4TU9XXzvHEmsNxGgBwvhSt09DpKJPAP/NPw2Z2a25okVldHGQMcPSlQYR/9i5gI=
+  gem: base32-url
+  on:
+    tags: true
+    repo: datacite/base32-url

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+[![Gem Version](https://badge.fury.io/rb/base32-url.svg)](https://badge.fury.io/rb/base32-url)
+[![Build Status](https://travis-ci.org/datacite/base32-url.svg?branch=master)](https://travis-ci.org/datacite/base32-url)
+
+An implementation of Douglas Crockfords Base32-Encoding in Ruby, with two modifications to make
+the resulting strings more URL friendly:
+
+* use lower case characters
+* only use characters that don't need URL encoding for checksum
+
+see <http://www.crockford.com/wrmg/base32.html>
+
+## Installation
+
+```
+$ gem install base32-url
+```
+
+## Changes
+
+```
+0.3.0 - encode into lower case characters, use * ~ _ ^ u for checksum
+0.2.0 - added optional checksum
+```
+
+## Usage
+
+```
+#!/usr/bin/env ruby
+
+require 'base32/url'
+
+Base32::Url.encode(1234)                            # => "16J"
+Base32::Url.encode(100**10, :split=>5, :length=>15) # => "02PQH-TY5NH-H0000"
+Base32::Url.decode("2pqh-ty5nh-hoooo")              # => 10**100
+Base32::Url.encode(1234, checksum: true)            # => "16JD"
+Base32::Url.decode("16JD", checksum: true)          # => 1234

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift './lib'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test)
+
+task :default => :test
+

data/base32-url.gemspec

@@ -0,0 +1,26 @@
+require "date"
+require File.expand_path("../lib/base32/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = "Martin Fenner"
+  s.email         = "mfenner@datacite.org"
+  s.name          = "base32-url"
+  s.homepage      = "https://github.com/datacite/base32-url"
+  s.summary       = "Ruby client library for conversion of DOI Metadata"
+  s.date          = Date.today
+  s.description   = "32-symbol notation for expressing numbers in a form that can be conveniently and accurately transmitted between humans. URL-friendly version of the base32-crockford gem."
+  s.require_paths = ["lib"]
+  s.version       = Base32::Url::VERSION
+  s.extra_rdoc_files = ["README.md"]
+  s.license       = 'MIT'
+  s.required_ruby_version = '~> 2.2'
+
+  # Declary dependencies here, rather than in the Gemfile
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'test-unit', '~> 3.2.3'
+
+  s.require_paths = ["lib"]
+  s.files       = `git ls-files`.split($/)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/base32-url.rb

@@ -0,0 +1 @@
+require 'base32/url'

data/lib/base32/url.rb

@@ -0,0 +1,157 @@
+# encoding: UTF-8
+#
+# (c) 2008, Levin Alexander <http://levinalex.net>
+#
+# This file is released under the same license as ruby.
+
+require 'enumerator'
+
+module Base32
+end
+
+# encode a value with the encoding defined by _Douglas_ _Crockford_ in
+# <http://www.crockford.com/wrmg/base32.html>
+#
+# this is *not* the same as the Base32 encoding defined in RFC 4648
+#
+#
+# The Base32 symbol set is a superset of the Base16 symbol set.
+#
+# We chose a symbol set of 10 digits and 22 letters. We exclude 4 of the 26
+# letters: I L O U.
+#
+# Excluded Letters
+#
+# I:: Can be confused with 1
+# L:: Can be confused with 1
+# O:: Can be confused with 0
+# U:: Accidental obscenity
+#
+# When decoding, upper and lower case letters are accepted, and i and l will
+# be treated as 1 and o will be treated as 0. When encoding, lower upper case
+# letters are used.
+#
+# If the bit-length of the number to be encoded is not a multiple of 5 bits,
+# then zero-extend the number to make its bit-length a multiple of 5.
+#
+# Hyphens (-) can be inserted into symbol strings. This can partition a
+# string into manageable pieces, improving readability by helping to prevent
+# confusion. Hyphens are ignored during decoding. An application may look for
+# hyphens to assure symbol string correctness.
+#
+#
+class Base32::URL
+  ENCODE_CHARS =
+    %w(0 1 2 3 4 5 6 7 8 9 a b c d e f g h j k m n p q r s t v w x y z ?)
+
+  DECODE_MAP = ENCODE_CHARS.to_enum(:each_with_index).inject({}) do |h,(c,i)|
+    h[c] = i; h
+  end.merge({'i' => 1, 'l' => 1, 'o' => 0})
+
+  CHECKSUM_CHARS = %w(* ~ _ ^ u)
+
+  CHECKSUM_MAP = { "*" => 32, "~" => 33, "_" => 34, "^" => 35, "u" => 36 }
+
+  # encodes an integer into a string
+  #
+  # when +checksum+ is given, a checksum is added at the end of the the string,
+  # calculated as modulo 37 of +number+. Five additional checksum symbols are
+  # used for symbol values 32-36
+  #
+  # when +split+ is given a hyphen is inserted every <n> characters to improve
+  # readability
+  #
+  # when +length+ is given, the resulting string is zero-padded to be exactly
+  # this number of characters long (hyphens are ignored)
+  #
+  #   Base32::URL.encode(1234) # => "16j"
+  #   Base32::URL.encode(123456789012345, :split=>5) # => "3g923-0vqvs"
+  #
+  def self.encode(number, opts = {})
+    # verify options
+    raise ArgumentError unless (opts.keys - [:length, :split, :checksum] == [])
+
+    str = number.to_s(2).reverse.scan(/.{1,5}/).map do |bits|
+      ENCODE_CHARS[bits.reverse.to_i(2)]
+    end.reverse.join
+
+    str += (ENCODE_CHARS + CHECKSUM_CHARS)[number % 37] if opts[:checksum]
+
+    str = str.rjust(opts[:length], '0') if opts[:length]
+
+    if opts[:split]
+      str = str.reverse
+      str = str.scan(/.{1,#{opts[:split]}}/).map { |x| x.reverse }
+      str = str.reverse.join("-")
+    end
+
+    str
+  end
+
+  # decode a string to an integer using Douglas Crockfords Base32 Encoding
+  #
+  # the string is converted to uppercase and hyphens are stripped before
+  # decoding
+  #
+  #   I,i,l,L decodes to 1
+  #   O,o decodes to 0
+  #
+  #   Base32::Crockford.decode("16J") # => 1234
+  #   Base32::Crockford.decode("OI") # => 1
+  #   Base32::Crockford.decode("3G923-0VQVS") # => 123456789012345
+  #
+  # returns +nil+ if the string contains invalid characters and can't be
+  # decoded, or if checksum option is used and checksum is incorrect
+  #
+  def self.decode(string, opts = {})
+    if opts[:checksum]
+      checksum_char = string.slice!(-1)
+      checksum_number = DECODE_MAP.merge(CHECKSUM_MAP)[checksum_char]
+    end
+
+    number = clean(string).split(//).map { |char|
+      DECODE_MAP[char] or return nil
+    }.inject(0) { |result,val| (result << 5) + val }
+
+    return nil if opts[:checksum] && (number % 37 != checksum_number)
+
+    number
+  end
+
+  # same as decode, but raises ArgumentError when the string can't be decoded
+  #
+  def self.decode!(string, opts = {})
+    decode(string) or raise ArgumentError
+  end
+
+  # return the canonical encoding of a string. converts it to uppercase
+  # and removes hyphens
+  #
+  # replaces invalid characters with a question mark ('?')
+  #
+  def self.normalize(string, opts = {})
+    checksum_char = string.slice!(-1) if opts[:checksum]
+
+    string = clean(string).split(//).map do |char|
+      ENCODE_CHARS[DECODE_MAP[char] || 32]
+    end.join
+
+    string += checksum_char if opts[:checksum]
+
+    string
+  end
+
+  # returns false if the string contains invalid characters and can't be
+  # decoded
+  #
+  def self.valid?(string, opts = {})
+    !(normalize(string, opts) =~ /\?/)
+  end
+
+  class << self
+    def clean(string)
+      string.gsub(/-/,'').downcase
+    end
+    private :clean
+  end
+end

data/lib/base32/version.rb

@@ -0,0 +1,5 @@
+module Base32
+  module Url
+    VERSION = "0.3"
+  end
+end

data/test/test_base32_url.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require 'test/unit'
+require 'base32/url'
+
+class TestBase32Url < Test::Unit::TestCase
+
+  def test_encoding_and_decoding_single_chars
+    from = (0..31).to_a
+    to = %w(0 1 2 3 4 5 6 7 8 9 a b c d e f g h j k m n p q r s t v w x y z)
+
+    from.zip(to) do |symbol_value, encode_symbol|
+      assert_equal encode_symbol, Base32::URL.encode(symbol_value)
+      assert_equal symbol_value, Base32::URL.decode(encode_symbol)
+    end
+  end
+
+  def test_encoding_larger_numbers
+    assert_equal("10", Base32::URL.encode(32))
+    assert_equal("16j", Base32::URL.encode(1234))
+  end
+
+  def test_decoding_strings
+    assert_equal(1234, Base32::URL.decode("16J"))
+  end
+
+  def test_decoding_normalizes_symbols
+    assert_equal Base32::URL.decode('11100110'),
+      Base32::URL.decode('IL1O0ilo')
+  end
+
+  def test_decoding_lowercase
+    assert_equal Base32::URL.decode("abcdefghijklmnopqrstvwxyz"),
+      Base32::URL.decode("ABCDEFGHIJKLMNOPQRSTVWXYZ")
+  end
+
+  def test_decoding_invalid_strings
+    assert_equal nil, Base32::URL.decode("Ü'+?")
+    assert_raises(ArgumentError) { Base32::URL.decode!("'+?") }
+  end
+
+  def test_decode_should_ignore_hyphens
+    assert_equal 1234, Base32::URL.decode("1-6-j")
+  end
+
+  def test_normalize
+    assert_equal "he110w0r1d", Base32::URL.normalize("hello-world")
+    assert_equal "he110w0r1d", Base32::URL.normalize("HELLO-WORLD")
+    assert_equal "b?123", Base32::URL.normalize("BU-123")
+  end
+
+  def test_normalize_with_checksum
+    assert_equal "b?123", Base32::URL.normalize("BU-123", :checksum => true)
+    assert_equal "b123u", Base32::URL.normalize("B123u", :checksum => true)
+  end
+
+  def test_valid
+    assert_equal true, Base32::URL.valid?("hello-world")
+    assert_equal false, Base32::URL.valid?("BU-123")
+  end
+
+  def test_valid_with_checksum
+    assert_equal true, Base32::URL.valid?("b123u", :checksum => true)
+    assert_equal false, Base32::URL.valid?("bu-123", :checksum => true)
+  end
+
+  def test_length_and_hyphenization
+    assert_equal "0016j", Base32::URL.encode(1234, :length => 5)
+    assert_equal "0-01-6j",
+      Base32::URL.encode(1234, :length => 5, :split => 2)
+    assert_equal "00-010",
+      Base32::URL.encode(32, :length => 5, :split => 3)
+  end
+
+  def test_encoding_checksum
+    assert_equal "16jd",
+      Base32::URL.encode(1234, :checksum => true)
+    assert_equal "016jd",
+      Base32::URL.encode(1234, :length => 5, :checksum => true)
+    assert_equal "0-16-jd",
+      Base32::URL.encode(1234, :length => 5, :split => 2, :checksum => true)
+  end
+
+  def test_decoding_checksum
+    assert_equal 1234,
+      Base32::URL.decode("16jd", :checksum => true)
+    assert_equal 1234,
+      Base32::URL.decode("016jd", :length => 5, :checksum => true)
+    assert_equal 1234,
+      Base32::URL.decode("0-16-jd", :length => 5, :split => 2, :checksum => true)
+  end
+
+  def test_decoding_invalid_checksum
+    assert_equal nil,
+      Base32::URL.decode("16jc", :checksum => true)
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: base32-url
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Martin Fenner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+description: 32-symbol notation for expressing numbers in a form that can be conveniently
+  and accurately transmitted between humans. URL-friendly version of the base32-crockford
+  gem.
+email: mfenner@datacite.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- base32-url.gemspec
+- lib/base32-url.rb
+- lib/base32/url.rb
+- lib/base32/version.rb
+- test/test_base32_url.rb
+homepage: https://github.com/datacite/base32-url
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby client library for conversion of DOI Metadata
+test_files:
+- test/test_base32_url.rb