base32-url 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1905c3d866b4e3ce2f810b3a5c918c8ac20bdb2ae6e91a8ae8b6c2e366540274
-  data.tar.gz: effb748c3d55a28017ab77ff8b8f01803621fb617d247505d6c5c824b892921a
+  metadata.gz: 2636154ecf4c12b4aebc6f7d902512a068caa8d119a66222e4c6bc5f986b550a
+  data.tar.gz: 1a6f5b368de218189acde3401611f116182e48318739c3b417cd3356cbc9ff09
 SHA512:
-  metadata.gz: 10c13658735a6d31812e4e9c60b33f125dbf466fc8d37367e6aa3469b1da22bcffbecddfbec325b379131a7337fb79c924b19788365ae109050f254dd2dd0e9e
-  data.tar.gz: 5333b4899d6ed9a0bdcf0ac008973daf36955ef5a6fa9877f86395504d86d05e4e392da42c887d6671d6905cb44f857cf5b5f0e5e184ff80a38c7541c792d399
+  metadata.gz: 017d4b5c6246fbd756c03a39cc6746ccafe5fde79d2620f62321dd2ebc24c9ce4121ca1aecb1f03c26834c636806e0eeec7081f1a9260df8e9bae51d6b8cebac
+  data.tar.gz: fa73fb138288c1cec305373c74fa5e690129b52a066bf27e754f357912acf37b19767b588bac710dabfd151d6199d8869a2e8ffcf5d72da56c5a82e0c44bb032

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 DataCite
+
+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

@@ -5,7 +5,7 @@ An implementation of Douglas Crockfords Base32-Encoding in Ruby, with two modifi
 the resulting strings more URL friendly:
 
 * use lower case characters
-* only use characters that don't need URL encoding for checksum
+* use two digits (mod 97-10, ISO 7064) for the checksum
 
 see <http://www.crockford.com/wrmg/base32.html>
 
@@ -18,6 +18,7 @@ $ gem install base32-url
 ## Changes
 
 ```
+0.5.0 - use mod 97-10 (ISO 7064) to calculate checksum
 0.3.0 - encode into lower case characters, use * ~ _ ^ u for checksum
 0.2.0 - added optional checksum
 ```
@@ -32,5 +33,27 @@ 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
+Base32::URL.encode(1234, checksum: true)            # => "16j82"
+Base32::URL.decode("16j82", checksum: true)          # => 1234
+```
+
+## Development
+
+We use test-unit for unit testing:
+
+```
+bundle exec rake
+```
+
+Follow along via [Github Issues](https://github.com/datacite/base32-url/issues).
+
+### Note on Patches/Pull Requests
+
+* Fork the project
+* Write tests for your new feature or a test that reproduces a bug
+* Implement your feature or make a bug fix
+* Do not mess with Rakefile, version or history
+* Commit, push and make a pull request. Bonus points for topical branches.
+
+## License
+**base32-url** is released under the [MIT License](https://github.com/datacite/base32-url/blob/master/LICENSE.md).

data/lib/base32/url.rb

@@ -9,26 +9,22 @@ 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.
+# 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
+# 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
+# be treated as 1 and o will be treated as 0. When encoding, lower case
 # letters are used.
 #
 # If the bit-length of the number to be encoded is not a multiple of 5 bits,
@@ -44,19 +40,15 @@ 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
+  DECODE_MAP = ENCODE_CHARS.to_enum(:each_with_index).reduce({}) do |hsh, (c,i)|
+    hsh[c] = i
+    hsh
   end.merge({'i' => 1, 'l' => 1, 'o' => 0})
 
-  CHECKSUM_CHARS = %w(i l o u)
-
-  CHECKSUM_MAP = { "i" => 32, "l" => 33, "o" => 34, "u" => 35 }
-
   # encodes an integer into a string
   #
   # when +checksum+ is given, a checksum is added at the end of the the string,
-  # calculated as modulo 36 of +number+. Four additional checksum symbols are
-  # used for symbol values 32-35
+  # calculated as modulo 97-10 (ISO 7064)
   #
   # when +split+ is given a hyphen is inserted every <n> characters to improve
   # readability
@@ -75,7 +67,10 @@ class Base32::URL
       ENCODE_CHARS[bits.reverse.to_i(2)]
     end.reverse.join
 
-    str += (ENCODE_CHARS + CHECKSUM_CHARS)[number % 36] if opts[:checksum]
+    if opts[:checksum]
+      remainder = 98 - ((number * 100) % 97)
+      str += sprintf("%02d", remainder)
+    end
 
     str = str.rjust(opts[:length], '0') if opts[:length]
 
@@ -96,30 +91,29 @@ class Base32::URL
   #   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
+  #   Base32::URL.decode("16J") # => 1234
+  #   Base32::URL.decode("OI") # => 1
+  #   Base32::URL.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
+    string, checksum = string[0..-3], string[-2..-1].to_i if opts[:checksum]
 
     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 % 36 != checksum_number)
+    if opts[:checksum]
+      remainder = 98 - ((number * 100) % 97)
+      return nil if remainder != checksum
+    end
 
     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
@@ -130,13 +124,16 @@ class Base32::URL
   # replaces invalid characters with a question mark ('?')
   #
   def self.normalize(string, opts = {})
-    checksum_char = string.slice!(-1) if opts[:checksum]
+    if opts[:checksum]
+      checksum = string.split(//).last(2).join
+      string = string[0..-2]
+    end
 
     string = clean(string).split(//).map do |char|
       ENCODE_CHARS[DECODE_MAP[char] || 32]
     end.join
 
-    string += checksum_char if opts[:checksum]
+    string += checksum if opts[:checksum]
 
     string
   end

data/lib/base32/version.rb

@@ -1,5 +1,5 @@
 module Base32
   module Url
-    VERSION = "0.4"
+    VERSION = "0.5"
   end
 end

data/test/test_base32_url.rb

@@ -21,7 +21,7 @@ class TestBase32Url < Test::Unit::TestCase
   end
 
   def test_decoding_strings
-    assert_equal(1234, Base32::URL.decode("16J"))
+    assert_equal(1234, Base32::URL.decode("16j"))
   end
 
   def test_decoding_normalizes_symbols
@@ -50,8 +50,8 @@ class TestBase32Url < Test::Unit::TestCase
   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)
+    assert_equal "b?1223", Base32::URL.normalize("BU-123", :checksum => true)
+    assert_equal "b1223", Base32::URL.normalize("B123", :checksum => true)
   end
 
   def test_valid
@@ -73,25 +73,25 @@ class TestBase32Url < Test::Unit::TestCase
   end
 
   def test_encoding_checksum
-    assert_equal "16ja",
+    assert_equal "16j82",
       Base32::URL.encode(1234, :checksum => true)
-    assert_equal "016ja",
-      Base32::URL.encode(1234, :length => 5, :checksum => true)
-    assert_equal "0-16-ja",
-      Base32::URL.encode(1234, :length => 5, :split => 2, :checksum => true)
+    assert_equal "016j82",
+      Base32::URL.encode(1234, :length => 6, :checksum => true)
+    assert_equal "01-6j-82",
+      Base32::URL.encode(1234, :length => 6, :split => 2, :checksum => true)
   end
 
   def test_decoding_checksum
     assert_equal 1234,
-      Base32::URL.decode("16ja", :checksum => true)
+      Base32::URL.decode("16j82", :checksum => true)
     assert_equal 1234,
-      Base32::URL.decode("016ja", :length => 5, :checksum => true)
+      Base32::URL.decode("016j82", :length => 6, :checksum => true)
     assert_equal 1234,
-      Base32::URL.decode("0-16-ja", :length => 5, :split => 2, :checksum => true)
+      Base32::URL.decode("01-6j-82", :length => 6, :split => 2, :checksum => true)
   end
 
   def test_decoding_invalid_checksum
     assert_equal nil,
-      Base32::URL.decode("16jc", :checksum => true)
+      Base32::URL.decode("16j44", :checksum => true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base32-url
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Martin Fenner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - base32-url.gemspec