base32-url 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6700c1c53464c4318f6361ebe22cf4276c925f24bf92cc6fc841e2075c502e6a
-  data.tar.gz: 5b58a804226b9714abde687042e207d8d00a10ed0859c716ccefa1c350a7fd69
+  metadata.gz: 74ebd73eb20ec6ef25ff4fe3edd29f2346dcea1e8d8620a8151d415948b95194
+  data.tar.gz: 131fe2a1c3d678041228e223f4698b50e2b7181ff4c7c15d2e249add8b69f7ae
 SHA512:
-  metadata.gz: fa905b9b15aafdeb4ef156da982952e613d397b0f4dda8d5a1145eaeda61b461deeba2410f850564d20246ad5902c84d02d330602d1a30d7b9f9f0ede5b785c4
-  data.tar.gz: 1831d2538ff6892222341b9082db32ee93456e9385a0521db10a2549ef50eb7940e2cd57bcce3ae82c98518c010e6508c68994ce325699c6ab38293d45eb7780
+  metadata.gz: 9db5cdc495c36f92f8707e7b7391cfa2eb0acbe2e722cff72ee55f55bde91447d2e58d38a4dc43d6f255844f51dd912f8c640e1629d48e0de1f0d2fe6e659794
+  data.tar.gz: fec4321eb6603afea990c427e90bc421d381dda5188292c34e71049681cd4a9d47132e30530adb2c308038466faf1ff0b338301c1dc62c76164f30c8c49d0969

data/base32-url.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.6.0'
 
   # Declary dependencies here, rather than in the Gemfile
+  s.add_dependency 'uuidtools', '~> 2.1', '>= 2.1.5'
   s.add_development_dependency 'bundler', '>= 1.11', "< 3"
   s.add_development_dependency 'rake', '>= 11.3', "< 14"
   s.add_development_dependency 'rubocop', '~> 1.36'

data/lib/base32/url.rb

@@ -35,6 +35,8 @@ end
 # hyphens to assure symbol string correctness.
 #
 #
+require 'uuidtools'
+
 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 ?].freeze
@@ -81,6 +83,30 @@ class Base32::URL
     str
   end
 
+  # encodes a uuid into a string
+  #
+  # when +checksum+ is given, a checksum is added at the end of the the string,
+  # calculated as modulo 97-10 (ISO 7064)
+  #
+  # 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_uuid('0022b9ef-525a-4a79-81ad-13411697f58a') # => "16j"
+  #   Base32::URL.encode_uuid('6179ad80-cc7f-4904-9260-0ecb3c3a90ba', :split=>5) # => "3g923-0vqvs"
+  #
+
+  def self.encode_uuid(uuid, opts = {})
+    # verify options
+    raise ArgumentError unless opts.keys - %i[length split checksum] == []
+
+    number = ::UUIDTools::UUID.parse(uuid).to_i
+
+    encode(number, opts)
+  end
+
   # decode a string to an integer using Douglas Crockfords Base32 Encoding
   #
   # the string is converted to uppercase and hyphens are stripped before
@@ -114,6 +140,26 @@ class Base32::URL
     number
   end
 
+  # decode a string to a uuid 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::URL.decode_uuid("4awyymjt99wr3b8k84b9fxca") # => '0022b9ef-525a-4a79-81ad-13411697f58a'
+  #
+  # 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_uuid(string, opts = {})
+    number = decode(string, opts)
+    return nil unless number
+
+    ::UUIDTools::UUID.parse_int(number).to_s
+  end
+
   # same as decode, but raises ArgumentError when the string can't be decoded
   def self.decode!(string, _opts = {})
     decode(string) or raise ArgumentError

data/lib/base32/version.rb

@@ -2,6 +2,6 @@
 
 module Base32
   module Url
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/test/test_base32_url.rb

@@ -24,6 +24,12 @@ class TestBase32Url < Test::Unit::TestCase
     assert_equal('16j', Base32::URL.encode(1234))
   end
 
+  def test_encoding_uuids
+    assert_equal('4awyymjt99wr3b8k84b9fxca', Base32::URL.encode_uuid('0022b9ef-525a-4a79-81ad-13411697f58a'))
+    assert_equal('31f6p-r1k3z94-294r0es-cy3n45t', Base32::URL.encode_uuid('6179ad80-cc7f-4904-9260-0ecb3c3a90ba', split: 7))
+    assert_equal('6315bn4-aqg82ja-4a9wxdt-29f7279', Base32::URL.encode_uuid('c3095752-2af0-40a4-a229-3ceb7424bce2', split: 7, checksum: true))
+  end
+
   def test_decoding_strings
     assert_equal(1234, Base32::URL.decode('16j'))
   end
@@ -43,6 +49,13 @@ class TestBase32Url < Test::Unit::TestCase
     assert_raises(ArgumentError) { Base32::URL.decode!("'+?") }
   end
 
+  def test_decoding_uuids
+    assert_equal('0022b9ef-525a-4a79-81ad-13411697f58a', Base32::URL.decode_uuid('4awyymjt99wr3b8k84b9fxca'))
+    assert_equal('6179ad80-cc7f-4904-9260-0ecb3c3a90ba', Base32::URL.decode_uuid('31f6p-r1k3z94-294r0es-cy3n45t'))
+    assert_equal('c3095752-2af0-40a4-a229-3ceb7424bce2', Base32::URL.decode_uuid('6315bn4-aqg82ja-4a9wxdt-29f7279', checksum: true))
+    assert_equal(nil, Base32::URL.decode_uuid('6315bn4-aqg82ja-4a9wxdt-29f7297', checksum: true))
+  end
+
   def test_decode_should_ignore_hyphens
     assert_equal 1234, Base32::URL.decode('1-6-j')
   end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: base32-url
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Martin Fenner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: 32-symbol notation for expressing numbers in a form that can be conveniently