uri-ni 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602b4c24ac2df2c79fc1a49a609097b79cddcc1c093a59c4d6fb145879eb2912
-  data.tar.gz: cf4a624236856b43a2dbb64ebe7a48e12d92289c9fe6c4c6cee5ad9aae5c86af
+  metadata.gz: eff8af7f69a76b24ce06948c53ad963d39552ec2dee0b08179496a1a8eb5d2a1
+  data.tar.gz: d7d285ac8eb47acf9acd0cd3de7dbcad6110c9e80f1860817534b18c1e25d87c
 SHA512:
-  metadata.gz: 42bfd075838370ed2a2c2098d3249b7587d148c49da3ace39019448aec20937d3c2a6f0c53b456490c1cacaf3c3d9d026329e9f1a6929d7eaa3a728f3a7df618
-  data.tar.gz: 16f3de0b2522d6fae59499151b4942b0c1cdb0174a5196ab534685209e9a23b462306b5f2b37c00281dbe518000717cbf6db717638e39f9951052d9baf0b9346
+  metadata.gz: 4bbdf0f3d6fd23db734e13403e20d96f6e29730c43f93351556a47ab10250508b743497c02870bcb7447d643e31254686a889277e5bbf10941caef329b6b71d2
+  data.tar.gz: b777dc59e94aff9e947cfd4661b64aecc727baeae4a2c5cc14fed58c8b59fd4495bb6ae935864a2e61a8fb9dbb86098e3665475baa2c59127975d97b734f5046

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -48,20 +48,28 @@ result and compute a new digest with it:
 ni
 # => #<URI::NI ni:///lol;wut>
 ni.compute 'derp'
-ArgumentError: lol is not a supported digest algorithm.
+# URI::InvalidComponentError: Can't resolve a Digest context for the algorithm lol.
 ```
 
-Similarly, the digest component of the URI can be anything going in to
-the parser, but only base64 is valid for subsequent manipulation:
+The purpose of this configuration is so that the parser doesn't croak
+on unexpected input, but otherwise assumes you know what you're
+doing. As such, there is no attempt to measure or otherwise divine the
+representation of any updates to the `digest` component:
 
-```
-ni.digest = '$#!%$%'
-ArgumentError: Data $#!%$% is not in base64
+```ruby
+ni = URI::NI.compute 'some data'
+# => #<URI::NI ni:///sha-256;EweZDmulyhRes16ZGCqb7EZTG8VN32VqYCx4D6AkDe4>
+ni.digest = 'whatever'
+# => "whatever"
+ni
+# => #<URI::NI ni:///sha-256;d2hhdGV2ZXI>
 ```
 
 In addition to computing new digest URIs, this module will return the
-interesting part of its contents in binary, base64, hexadecimal, and
+interesting part of its contents in binary, hexadecimal, base64, and
 (with a soft dependency), [base32](https://rubygems.org/gems/base32).
+There are accessors and mutators for `digest`, `hexdigest`,
+`b32digest`, and `b64digest`.
 
 Finally, this module will also reuse any extant `Digest::Instance`
 object as long as it is in the inventory, and furthermore the

data/lib/uri/ni/version.rb

@@ -3,7 +3,7 @@ require 'uri/generic'
 
 module URI
   class NI < Generic
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 
   # might as well put this here

data/lib/uri/ni.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'uri/ni/version'
 require 'uri'
 require 'uri/generic'
@@ -79,6 +80,65 @@ class URI::NI < URI::Generic
     m.captures
   end
 
+  def assert_radix radix
+    raise ArgumentError,
+      "Radix must be 16, 32, 64, or 256, not #{radix.inspect}" unless
+      [256, 64, 32, 16].include? radix
+    radix
+  end
+
+  # assertions about data representation
+  ASSERT = {
+    256 => [/.*/, ''],
+    64  => [/^[0-9A-Za-z+\/_-]*=*$/, 'Data %s is not in base64'],
+    32  => [/^[2-7A-Za-z]*=*$/, 'Data %s is not in base32'],
+    16  => [/^[0-9A-Fa-f]*$/, 'Data %s is not in hexadecimal'],
+  }
+
+  def assert_repr data, radix
+    re, error = ASSERT[radix]
+    raise ArgumentError, error % data unless re.match data
+  end
+
+  # from whatever to binary
+  DECODE = {
+    256 => -> x { x },
+    64  => -> x { Base64.decode64 x.tr('-_', '+/') },
+    32  => -> x { require 'base32'; Base32.decode x },
+    16  => -> x { [x].pack 'H*' },
+  }
+
+  # from binary to whatever
+  ENCODE = {
+    256 => -> x { x },
+    64  => -> x { Base64.urlsafe_encode64(x).tr '=', '' },
+    32  => -> x { require 'base32'; Base32.encode(x).tr '=', '' },
+    16  => -> x { x.unpack1 'H*' },
+  }
+
+  # canonical and alternative representations
+  CANON = {
+    256 => -> x { x },
+    64  => -> x { x.tr('=', '').tr '+/', '-_' },
+    32  => -> x { x.tr('=', '').upcase },
+    16  => -> x { x.downcase },
+  }
+
+  # note if we put the padding here then we sanitize input as well
+
+  ALT = {
+    256 => -> x { x },
+    64  => -> x { x.tr('=', '').tr '-_', '+/' },
+    32  => -> x { x.tr('=', '').downcase },
+    16  => -> x { x.upcase },
+  }
+
+  def transcode data, from: 256, to: 256, alt: false
+    assert_repr data, from
+    data = ENCODE[to].call(DECODE[from].call data) unless from == to
+    alt ? ALT[to].call(data) : CANON[to].call(data)
+  end
+
   protected
 
   # holy crap you can override these?
@@ -127,8 +187,8 @@ class URI::NI < URI::Generic
     else
       # make sure we're all on the same page hurr
       self.algorithm = algorithm ||= self.algorithm
-      raise ArgumentError,
-        "#{algorithm} is not a supported digest algorithm." unless
+      raise URI::InvalidComponentError,
+        "Can't resolve a Digest context for the algorithm #{algorithm}." unless
         ctx = DIGESTS[algorithm]
       ctx = ctx.new
     end
@@ -157,8 +217,7 @@ class URI::NI < URI::Generic
     end
 
     self.set_path("/#{algorithm};" +
-      ctx.base64digest.gsub(/[+\/]/, ?+ => ?-, ?/ => ?_).gsub(/=/, ''))
-
+      ctx.base64digest.tr('+/', '-_').tr('=', ''))
     self
   end
 
@@ -184,7 +243,7 @@ class URI::NI < URI::Generic
   def algorithm= algo
     a, b = assert_path
     self.path   = "/#{algo}"
-    self.digest = b if b
+    self.set_digest(b, radix: 64) if b
     a.to_sym if a
   end
 
@@ -223,46 +282,51 @@ class URI::NI < URI::Generic
   # @return [String] The digest of the URI in the given representation
   #
   def digest radix: 256, alt: false
-    case radix
-    when 256
-      # XXX do not use urlsafe_decode64; it will complain if the
-      # thingies aren't aligned
-      Base64.decode64(raw_digest.tr('-_', '+/'))
-    when 64
-      b64digest alt: alt
-    when 32
-      b32digest alt: alt
-    when 16
-      hexdigest alt: alt
-    else
-      raise ArgumentError, "Radix must be 16, 32, 64, 256, not #{radix}"
-    end
+    assert_radix radix
+    transcode raw_digest, from: 64, to: radix, alt: alt
   end
 
-  # Set the digest to the data. Data may either be a
-  # +Digest::Instance+ or a base64 string. String representations will
-  # be normalized to {https://tools.ietf.org/html/rfc3548#section-4
-  # RFC 3548} base64url, i.e. +\+/+ will be replaced with +-_+ and
-  # padding (+=+) will be removed. +Digest::Instance+ objects will
+  # Set the digest to the data, with an optional radix. Data may
+  # either be a +Digest::Instance+—in which case the radix is
+  # ignored–a string, or +nil+. +Digest::Instance+ objects will
   # just be run through #compute, with all that entails.
-  def digest= data
-    a = assert_path.first
-    case data
+  #
+  # @param value [String, nil, Digest::Instance] The new digest
+  # @param radix [256, 64, 32, 16] The radix of the encoding (default 256)
+  # @return [String] The _old_ digest in the given radix
+  #
+  def set_digest value, radix: 256
+    assert_radix radix
+
+    a, d = assert_path
+
+    case value
     when Digest::Instance
-      compute data
+      compute value
     when String
-      raise ArgumentError, "Data #{data} is not in base64" unless
-        /^[0-9A-Za-z+\/_-]*=*$/.match(data)
-      data = data.tr('+/', '-_').tr('=', '')
-      self.path = a ? "/#{a};#{data}" : "/;#{data}"
+      value = transcode value, from: radix, to: 64
+      self.path = a ? "/#{a};#{value}" : "/;#{value}"
     when nil
       self.path = a ? "/#{a}" : ?/
     else
       raise ArgumentError,
-        "Data must be a string or Digest::Instance, not #{data.class}"
+        "Value must be a string or Digest::Instance, not #{value.class}"
     end
 
-    data
+    # bail out if nil
+    return unless d
+    transcode d, from: 64, to: radix
+  end
+
+  # Set the digest to the data. Data may either be a
+  # +Digest::Instance+ or a _binary_ string. +Digest::Instance+
+  # objects will just be run through #compute, with all that entails.
+  #
+  # @param value [String, nil, Digest::Instance] the new digest
+  # @return [String, nil, Digest::Instance] the value passed in
+  #
+  def digest= value
+    return set_digest value
   end
 
   # Return the digest in its hexadecimal notation. Optionally give
@@ -273,44 +337,59 @@ class URI::NI < URI::Generic
   # @return [String] The hexadecimal digest
   #
   def hexdigest alt: false
-    str = digest.unpack('H*').first
-    return str.upcase if alt
-    str
+    transcode raw_digest, from: 64, to: 16, alt: alt
+  end
+
+  # Set the digest value, assuming a hexadecimal input.
+  # @param value [String, nil, Digest::Instance] the new digest
+  # @return [String, nil, Digest::Instance] the value passed in
+  def hexdigest= value
+    set_digest value, radix: 16
   end
 
   # Return the digest in its base32 notation. Optionally give
   # +alt:+ a truthy value to return an alternate (lowercase)
-  # representation. Note this method requires
+  # representation. Note this method requires the base32 module.
   #
   # @param alt [false, true] Return the alternative representation
   # @return [String] The base32 digest
   #
   def b32digest alt: false
-    require 'base32'
-    ret = Base32.encode(digest).gsub(/=+/, '')
-    return ret.downcase if alt
-    ret.upcase
+    transcode raw_digest, from: 64, to: 32, alt: alt
   end
 
-  # Return the digest in its base64 notation. Optionally give
-  # +alt:+ a truthy value to return an alternate (URL-safe)
-  # representation.
+  # Set the digest value, assuming a base32 input (requires base32).
+  # @param value [String, nil, Digest::Instance] the new digest
+  # @return [String, nil, Digest::Instance] the value passed in
+  def b32digest= value
+    set_digest value, radix: 32
+  end
+
+  # Return the digest in its base64 notation. Note it is the
+  # _default_ representation that is URL-safe, for parity with the
+  # identifier itself. Give +alt:+ a truthy value to return a plain
+  # (_non_-URL-safe) base64 representation.
   #
   # @param alt [false, true] Return the alternative representation
   # @return [String] The base64 digest
   #
   def b64digest alt: false
-    ret = raw_digest
-    return ret.gsub(/[-_]/, ?- => ?+, ?_ => ?/) unless alt
-    ret
+    transcode raw_digest, from: 64, to: 64, alt: alt
+  end
+
+  # Set the digest value, assuming a base64 input.
+  # @param value [String, nil, Digest::Instance] the new digest
+  # @return [String, nil, Digest::Instance] the value passed in
+  def b64digest= value
+    set_digest value, radix: 64
   end
 
   # Returns a +/.well-known/...+, either HTTPS or HTTP URL, given the
   # contents of the +ni:+ URI.
   #
   # @param authority [#to_s, URI] Override the authority part of the URI
-  # @param https [true, false] whether the URL is to be HTTPS.
-  # @return [URI::HTTPS, URI::HTTP]
+  # @param https [true, false] Whether the URL is to be HTTPS.
+  # @return [URI::HTTPS, URI::HTTP] The generated URL.
   #
   def to_www https: true, authority: nil
     a, d = assert_path
@@ -327,13 +406,13 @@ class URI::NI < URI::Generic
     if authority
       uhp = []
       if authority.is_a? URI
-        raise ArgumentError, "Bad authority #{authority}" unless
+        raise URI::InvalidComponentError, "Bad authority #{authority}" unless
           %i[userinfo host port].all? {|c| authority.respond_to? c }
         uhp = [authority.userinfo, authority.host, authority.port]
         uhp[2] = nil if authority.port == authority.class::DEFAULT_PORT
       else
         authority = authority.to_s
-        uhp = AUTH_RE.match(authority) or raise ArgumentError,
+        uhp = AUTH_RE.match(authority) or raise URI::InvalidComponentError,
           "Invalid authority #{authority}"
         uhp = uhp.captures
       end

data/uri-ni.gemspec

@@ -24,10 +24,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # ruby
-  spec.required_ruby_version = Gem::Dependency.new('>= 2.3.0')
+  spec.required_ruby_version = '>= 2.3.0'
 
   # dev/test dependencies
   spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'base32',  '~> 0.3'
   # bundler put these in the gemfile i dunno wtf
   #spec.add_development_dependency 'rake',    '~> 12.0'
   #spec.add_development_dependency 'rspec',   '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uri-ni
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dorian Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-04 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: ''
 email:
 - code@doriantaylor.com
@@ -57,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="