ur 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e517b90ad97d890764bc228d8836e7e48d7f8250ed7c3a4878368b77b2deb2'
-  data.tar.gz: e87aedb3a622a5606bff0370cc1a06f43d98be53488389c1902e989226760cd1
+  metadata.gz: a39ab1a17905dc8a0fb40eb22896580951abec8cfe78a11c4a1fd558ca6c6917
+  data.tar.gz: 5915b4da516b30c6ee291eb7f5a5bb5a8f974d30da327d5660a9b1a0549068a8
 SHA512:
-  metadata.gz: '069f50e6768b41beb13830308fd3a3d18845c32fc38f6e95755b8f929ba88e20efcfce8f84abf50ed393a93f9c2971bb7b280e5793d43098c06dc034f136487c'
-  data.tar.gz: 42c005bf4853f4bb946a2bd143696c84fa84c6f933b71a6425505722aab150f290ab21265ac2b6e9fdaa313e0207becb46f5a14ff20a7cd2c18e4daa53d12084
+  metadata.gz: e59ca34e85e21e8c659a10e57cffad39d3fa718389bed6ccb6e4327cb33b237569517bb8d5c2eb93272a0c20634966697823a7142f1d861ba58c933dad5342c6
+  data.tar.gz: 3ab8ad92c6e70fc3dd87928a200a500e8bd5d27440fd9c2b3e35d46d3778aed80122cefda50875cb0bb6f84dcba75fbc24bdc194d88d4f345439b97f98f7b9b6

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.2.2
+
+- Ur::Weblink
+- JSI v0.7.0
+- Ruby 3
+
+# v0.2.1
+
+- JSI v0.6.0
+
 # v0.2.0
 
 - Ur uses JSI schema modules instead of classes

data/README.md

@@ -61,6 +61,6 @@ end
 
 ## License
 
-[<img align="right" src="https://github.com/notEthan/ur/raw/master/resources/icons/LGPL-3.0.png">](https://www.gnu.org/licenses/lgpl-3.0.html)
+[<img align="right" src="https://www.gnu.org/graphics/lgplv3-147x51.png">](https://www.gnu.org/licenses/lgpl-3.0.html)
 
-Ur is Open Source Software licensed under the terms of the [GNU Lesser General Public License version 3](https://www.gnu.org/licenses/lgpl-3.0.html).
+Ur is licensed under the terms of the [GNU Lesser General Public License version 3](https://www.gnu.org/licenses/lgpl-3.0.html).

data/lib/ur/content_type.rb

@@ -21,12 +21,15 @@ module Ur
   #   https://tools.ietf.org/html/rfc2045#section-5.1
   # - Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types
   #   https://tools.ietf.org/html/rfc2046
+  # - Additional Media Type Structured Syntax Suffixes
+  #   https://tools.ietf.org/html/rfc6839
   class ContentType < String
     # the character ranges in this SHOULD be significantly more restrictive,
-    # and the /<subtype> construct should not be optional. however, we'll aim
+    # and the `/<subtype>` construct should not be optional. however, we'll aim
     # to match whatever media type we are given.
     #
     # example:
+    #
     #     MEDIA_TYPE_REGEXP.match('application/vnd.github+json').named_captures
     #     =>
     #     {
@@ -38,6 +41,7 @@ module Ur
     #     }
     #
     # example of being more permissive than the spec allows:
+    #
     #     MEDIA_TYPE_REGEXP.match('where the %$*! am I').named_captures
     #     =>
     #     {
@@ -116,46 +120,55 @@ module Ur
       freeze
     end
 
-    # @return [String, nil] the media type of this content type.
-    #   e.g. "application/vnd.github+json" in content-type: application/vnd.github+json; charset="utf-8"
+    # the media type of this content type.
+    # e.g. `"application/vnd.github+json"` in `content-type: application/vnd.github+json; charset="utf-8"`
+    # @return [String, nil]
     attr_reader :media_type
 
-    # @return [String, nil] the 'type' portion of our media type.
-    #   e.g. "application" in content-type: application/vnd.github+json; charset="utf-8"
+    # the 'type' portion of our media type.
+    # e.g. `"application"` in `content-type: application/vnd.github+json; charset="utf-8"`
+    # @return [String, nil]
     attr_reader :type
 
-    # @return [String, nil] the 'subtype' portion of our media type.
-    #   e.g. "vnd.github+json" in content-type: application/vnd.github+json; charset="utf-8"
+    # the 'subtype' portion of our media type.
+    # e.g. `"vnd.github+json"` in `content-type: application/vnd.github+json; charset="utf-8"`
+    # @return [String, nil]
     attr_reader :subtype
 
-    # @return [String, nil] the 'facet' portion of our media type.
-    #   e.g. "vnd" in content-type: application/vnd.github+json; charset="utf-8"
+    # the 'facet' portion of our media type.
+    # e.g. `"vnd"` in `content-type: application/vnd.github+json; charset="utf-8"`
+    # @return [String, nil]
     attr_reader :facet
 
-    # @return [String, nil] the 'suffix' portion of our media type.
-    #   e.g. "json" in content-type: application/vnd.github+json; charset="utf-8"
+    # the 'suffix' portion of our media type.
+    # e.g. `"json"` in `content-type: application/vnd.github+json; charset="utf-8"`
+    # @return [String, nil]
     attr_reader :suffix
 
-    # @return [Hash<String, String>] parameters of this content type.
-    #   e.g. {"charset" => "utf-8"} in content-type: application/vnd.github+json; charset="utf-8"
+    # parameters of this content type.
+    # e.g. `{"charset" => "utf-8"}` in `content-type: application/vnd.github+json; charset="utf-8"`
+    # @return [Hash<String, String>]
     attr_reader :parameters
 
+    # is the 'type' portion of our media type equal (case-insensitive) to the given other_type
     # @param other_type
-    # @return [Boolean] is the 'type' portion of our media type equal (case-insensitive) to the given other_type
+    # @return [Boolean]
     def type?(other_type)
-      type && type.casecmp?(other_type)
+      type ? type.casecmp?(other_type) : false
     end
 
+    # is the 'subtype' portion of our media type equal (case-insensitive) to the given other_subtype
     # @param other_subtype
-    # @return [Boolean] is the 'subtype' portion of our media type equal (case-insensitive) to the given other_subtype
+    # @return [Boolean]
     def subtype?(other_subtype)
-      subtype && subtype.casecmp?(other_subtype)
+      subtype ? subtype.casecmp?(other_subtype) : false
     end
 
+    # is the 'suffix' portion of our media type equal (case-insensitive) to the given other_suffix
     # @param other_suffix
-    # @return [Boolean] is the 'suffix' portion of our media type equal (case-insensitive) to the given other_suffix
+    # @return [Boolean]
     def suffix?(other_suffix)
-      suffix && suffix.casecmp?(other_suffix)
+      suffix ? suffix.casecmp?(other_suffix) : false
     end
 
     SOME_TEXT_SUBTYPES = %w(
@@ -173,11 +186,12 @@ module Ur
       ecmascript
     ).map(&:freeze).freeze
 
+    # does this content type appear to be binary?
+    # this library makes its best guess based on a very incomplete knowledge
+    # of which media types indicate binary or text.
     # @param unknown [Boolean] return this value when we have no idea whether
     #   our media type is binary or text.
-    # @return [Boolean] does this content type appear to be binary?
-    #   this library makes its best guess based on a very incomplete knowledge
-    #   of which media types indicate binary or text.
+    # @return [Boolean]
     def binary?(unknown: true)
       return false if type_text?
 
@@ -192,54 +206,64 @@ module Ur
       return unknown
     end
 
-    # @return [Boolean] is this a JSON content type?
+    # is this a JSON content type?
+    # @return [Boolean]
     def json?
       suffix ? suffix.casecmp?('json') : subtype ? subtype.casecmp?('json') : false
     end
 
-    # @return [Boolean] is this an XML content type?
+    # is this an XML content type?
+    # @return [Boolean]
     def xml?
-      suffix ? suffix.casecmp?('xml'): subtype ? subtype.casecmp?('xml') : false
+      suffix ? suffix.casecmp?('xml') : subtype ? subtype.casecmp?('xml') : false
     end
 
-    # @return [Boolean] is this a x-www-form-urlencoded content type?
+    # is this a `x-www-form-urlencoded` content type?
+    # @return [Boolean]
     def form_urlencoded?
-      suffix ? suffix.casecmp?('x-www-form-urlencoded'): subtype ? subtype.casecmp?('x-www-form-urlencoded') : false
+      suffix ? suffix.casecmp?('x-www-form-urlencoded') : subtype ? subtype.casecmp?('x-www-form-urlencoded') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'text'
+    # is the 'type' portion of our media type 'text'
+    # @return [Boolean]
     def type_text?
-      type && type.casecmp?('text')
+      type ? type.casecmp?('text') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'image'
+    # is the 'type' portion of our media type 'image'
+    # @return [Boolean]
     def type_image?
-      type && type.casecmp?('image')
+      type ? type.casecmp?('image') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'audio'
+    # is the 'type' portion of our media type 'audio'
+    # @return [Boolean]
     def type_audio?
-      type && type.casecmp?('audio')
+      type ? type.casecmp?('audio') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'video'
+    # is the 'type' portion of our media type 'video'
+    # @return [Boolean]
     def type_video?
-      type && type.casecmp?('video')
+      type ? type.casecmp?('video') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'application'
+    # is the 'type' portion of our media type 'application'
+    # @return [Boolean]
     def type_application?
-      type && type.casecmp?('application')
+      type ? type.casecmp?('application') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'message'
+    # is the 'type' portion of our media type 'message'
+    # @return [Boolean]
     def type_message?
-      type && type.casecmp?('message')
+      type ? type.casecmp?('message') : false
     end
 
-    # @return [Boolean] is the 'type' portion of our media type 'multipart'
+    # is the 'type' portion of our media type 'multipart'
+    # @return [Boolean]
     def type_multipart?
-      type && type.casecmp?('multipart')
+      type ? type.casecmp?('multipart') : false
     end
   end
 end

data/lib/ur/middleware.rb

@@ -30,7 +30,7 @@ module Ur
   class FaradayMiddleware < ::Faraday::Middleware
     include Ur::Middleware
     def call(request_env)
-      ur = Ur.from_faraday_request(request_env, @options.select { |k, _| [:schemas].include?(k) })
+      ur = Ur.from_faraday_request(request_env, **@options.select { |k, _| [:schemas].include?(k) })
       invoke_callback(:before_request, ur)
       begin_request(ur)
       ur.faraday_on_complete(@app, request_env) do |response_env|
@@ -43,7 +43,7 @@ module Ur
   class RackMiddleware
     include Ur::Middleware
     def call(env)
-      ur = Ur.from_rack_request(env, @options.select { |k, _| [:schemas].include?(k) })
+      ur = Ur.from_rack_request(env, **@options.select { |k, _| [:schemas].include?(k) })
       invoke_callback(:before_request, ur)
       begin_request(ur)
       ur.with_rack_response(@app, env) do

data/lib/ur/request_and_response.rb

@@ -25,9 +25,10 @@ module Ur
     end
     include FaradayEntity
 
-    # @return [Ur::ContentType] the string value of the content type header. returns an
+    # the string value of the content type header. returns an
     # {Ur::ContentType}, a subclass of String which additionally parses the Content-Type
     # according to relevant RFCs.
+    # @return [Ur::ContentType]
     def content_type
       headers.each do |k, v|
         return ContentType.new(v) if k =~ /\Acontent[-_]type\z/i
@@ -40,17 +41,20 @@ module Ur
       content_type ? content_type.media_type : nil
     end
 
-    # @return [Boolean] is our content type JSON?
+    # is our content type JSON?
+    # @return [Boolean]
     def json?
       content_type && content_type.json?
     end
 
-    # @return [Boolean] is our content type XML?
+    # is our content type XML?
+    # @return [Boolean]
     def xml?
       content_type && content_type.xml?
     end
 
-    # @return [Boolean] is our content type x-www-form-urlencoded?
+    # is our content type `x-www-form-urlencoded`?
+    # @return [Boolean]
     def form_urlencoded?
       content_type && content_type.form_urlencoded?
     end

data/lib/ur/sub_ur.rb

@@ -5,7 +5,7 @@ require 'ur' unless Object.const_defined?(:Ur)
 module Ur
   module SubUr
     def ur
-      parent_jsis.detect { |p| p.is_a?(::Ur) }
+      jsi_parent_nodes.detect { |p| p.is_a?(::Ur) }
     end
   end
 end

data/lib/ur/version.rb

@@ -1 +1 @@
-UR_VERSION = "0.2.0".freeze
+UR_VERSION = "0.2.2".freeze

data/lib/ur/weblink.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'ur' unless Object.const_defined?(:Ur)
+
+module Ur
+  # a RFC5988 Web Link
+  #
+  # https://tools.ietf.org/html/rfc5988
+  class Weblink
+    # Weblink::Error, base class for all errors of the Weblink class
+    class Error < StandardError
+    end
+
+    # error parsing a Weblink
+    class ParseError < Error
+    end
+
+    # error when attempting an operation that requires a context URI which was not provided
+    class NoContextError < Error
+    end
+
+    # parses an array of Web Links from the value an HTTP Link header, as described in
+    # https://tools.ietf.org/html/rfc5988#section-5
+    #
+    # returns an Array of Weblink objects
+    def self.parse_link_value(link_value, context_uri=nil)
+      links = []
+
+      return links unless link_value
+
+      attr_char = /[a-zA-Z0-9!#\$&+\-.^_`|~]/ # defined in https://tools.ietf.org/html/rfc5987#section-3.2.1
+      ptoken = %r([a-zA-Z0-9!#\$%&'()*+\-./:<=>?@\[\]^_`{|}~])
+      quoted_string = /"([^"]*)"/
+
+      require 'strscan'
+      ss = StringScanner.new(link_value)
+      parse_fail = proc do
+        raise ParseError, "Unable to parse link value: #{link_value} " +
+          "around character #{ss.pos}: #{ss.peek(link_value.length - ss.pos)}"
+      end
+
+      while !ss.eos?
+        # get the target_uri, within some angle brackets
+        ss.scan(/\s*<([^>]+)>/) || parse_fail.call
+        target_uri = ss[1]
+        attributes = {}
+        # get the attributes: semicolon, some attr_chars, an optional asterisk, equals, and a quoted
+        # string or series of unquoted ptokens
+        while ss.scan(/\s*;\s*(#{attr_char.source}+\*?)\s*=\s*(?:#{quoted_string.source}|(#{ptoken.source}+))\s*/)
+          attributes[ss[1]] = ss[2] || ss[3]
+        end
+        links << new(target_uri, attributes, context_uri)
+        unless ss.eos?
+          # either the string ends or has a comma followed by another link
+          ss.scan(/\s*,\s*/) || parse_fail.call
+        end
+      end
+      links
+    end
+
+    def initialize(target_uri, attributes, context_uri=nil)
+      @target_uri = to_addressable_uri(target_uri)
+      @attributes = attributes
+      @context_uri = to_addressable_uri(context_uri)
+    end
+
+    # the context uri of the link, as an Addressable URI. this URI must be absolute, and the target_uri
+    # may be resolved against it. this is most typically the request URI of a request to a service
+    attr_reader :context_uri
+
+    # RFC 5988 calls it IRI, but nobody else does. we'll throw in an alias.
+    alias_method :context_iri, :context_uri
+
+    # returns the target URI as an Addressable::URI
+    attr_reader :target_uri
+
+    # RFC 5988 calls it IRI, but nobody else does. we'll throw in an alias.
+    alias_method :target_iri, :target_uri
+
+    # attempts to make target_uri absolute, using context_uri if available. raises if
+    # there is not information available to make an absolute target URI
+    def absolute_target_uri
+      if target_uri.absolute?
+        target_uri
+      elsif context_uri
+        context_uri + target_uri
+      else
+        raise NoContextError, "Target URI is relative but no Context URI given - cannot determine absolute target URI"
+      end
+    end
+
+    # link attributes
+    attr_reader :attributes
+
+    # subscript returns an attribute of this Link, if defined, otherwise nil
+    def [](attribute_key)
+      @attributes[attribute_key]
+    end
+
+    # link rel attribute
+    def rel
+      self['rel']
+    end
+
+    alias_method :relation_type, :rel
+
+    # compares relation types in a case-insensitive manner as mandated in
+    # https://tools.ietf.org/html/rfc5988#section-4.1
+    def rel?(other_rel)
+      rel && other_rel && rel.downcase == other_rel.downcase
+    end
+
+    # a string of this weblink, appropriate for adding to a Link header
+    def to_s
+      "<#{target_uri}>" + attributes.map { |k,v| %Q(; #{k}="#{v}") }.join('')
+    end
+
+    private
+
+    # if uri is nil, returns nil; otherwise, tries to return a Addressable::URI
+    def to_addressable_uri(uri)
+      uri.nil? || uri.is_a?(Addressable::URI) ? uri : Addressable::URI.parse(uri)
+    end
+  end
+end

data/lib/ur.rb

@@ -6,9 +6,10 @@ require 'jsi'
 require 'time'
 require 'addressable/uri'
 require 'pathname'
+require 'yaml'
 
 UR_ROOT = Pathname.new(__FILE__).dirname.parent.expand_path
-Ur = JSI::Schema.new(YAML.load_file(UR_ROOT.join('resources/ur.schema.yml'))).jsi_schema_module
+Ur = JSI.new_schema_module(YAML.load_file(UR_ROOT.join('resources/ur.schema.yml')))
 module Ur
   VERSION = UR_VERSION
 
@@ -18,10 +19,11 @@ module Ur
   autoload :FaradayMiddleware, 'ur/middleware'
   autoload :RackMiddleware, 'ur/middleware'
   autoload :Faraday, 'ur/faraday'
+  autoload :Weblink, 'ur/weblink'
 
-  Request = self.schema.properties['request'].jsi_schema_module
-  Response = self.schema.properties['response'].jsi_schema_module
-  Metadata = self.schema.properties['metadata'].jsi_schema_module
+  Request = self.properties['request']
+  Response = self.properties['response']
+  Metadata = self.properties['metadata']
   require 'ur/request'
   require 'ur/response'
   require 'ur/metadata'
@@ -34,8 +36,7 @@ module Ur
         raise(TypeError, "expected hash for ur instance. got: #{instance.pretty_inspect.chomp}")
       end
 
-      ur_class = JSI.class_for_schemas(Set[schema] + schemas)
-      ur_class.new(instance, options).tap do |ur|
+      JSI::SchemaSet[schema, *schemas].new_jsi(instance, **options).tap do |ur|
         ur.request = {} if ur.request.nil?
         ur.response = {} if ur.response.nil?
         ur.metadata = {} if ur.metadata.nil?
@@ -51,7 +52,7 @@ module Ur
         env = request_env
       end
 
-      new({'bound' => 'inbound'}, options).tap do |ur|
+      new({'bound' => 'inbound'}, **options).tap do |ur|
         ur.request['method'] = rack_request.request_method
 
         ur.request.addressable_uri = Addressable::URI.new(
@@ -82,7 +83,7 @@ module Ur
     end
 
     def from_faraday_request(request_env, **options)
-      new({'bound' => 'outbound'}, options).tap do |ur|
+      new({'bound' => 'outbound'}, **options).tap do |ur|
         ur.request['method'] = request_env[:method].to_s
         ur.request.uri = request_env[:url].normalize.to_s
         ur.request.headers = request_env[:request_headers]
@@ -114,7 +115,7 @@ module Ur
     [status, response_headers, response_body_proxy]
   end
 
-  def faraday_on_complete(app, request_env, &block)
+  def faraday_on_complete(app, request_env)
     app.call(request_env).on_complete do |response_env|
       response.status = response_env[:status]
       response.headers = response_env[:response_headers]

data/resources/ur.schema.yml

@@ -1,3 +1,4 @@
+$schema: http://json-schema.org/draft-07/schema
 $id: https://schemas.ur.unth.net/ur
 type: object
 properties:

data/ur.gemspec

@@ -6,28 +6,25 @@ Gem::Specification.new do |spec|
   spec.name          = "ur"
   spec.version       = UR_VERSION
   spec.authors       = ["Ethan"]
-  spec.email         = ["ethan@unth"]
+  spec.email         = ["ethan.ur@unth.net"]
 
   spec.summary       = 'ur: unified request representation'
   spec.description   = 'ur provides a unified representation of a request and response. it can be interpreted from rack, faraday, or potentially other sources, and provides a consistent interface to access the attributes inherent to the request and additional useful parsers and computation from the request.'
   spec.homepage      = "https://github.com/notEthan/ur"
   spec.license       = "LGPL-3.0"
 
-  ignore_files   = %w(.gitignore .travis.yml Gemfile test)
-  ignore_files_re = %r{\A(#{ignore_files.map { |f| Regexp.escape(f) }.join('|')})(/|\z)}
-  spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(ignore_files_re) }
-  spec.test_files   = `git ls-files -z test`.split("\x0") + ['.simplecov']
+  spec.files = [
+    'LICENSE.md',
+    'CHANGELOG.md',
+    'README.md',
+    '.yardopts',
+    'resources/ur.schema.yml',
+    'ur.gemspec',
+    *Dir['lib/**/*'],
+  ].reject { |f| File.lstat(f).ftype == 'directory' }
+
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "~> 0.4"
+  spec.add_dependency "jsi", "~> 0.6"
   spec.add_dependency "addressable", "~> 2.0"
-  spec.add_development_dependency "rack"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "faraday"
-  spec.add_development_dependency "faraday_middleware"
-  spec.add_development_dependency "activesupport"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "simplecov"
 end