ur 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1161e5f2e2219053fc4c54e541feb0d4c6efa1c1af930365e526a88bc0973e1b
-  data.tar.gz: b42e166ae62f0a651d5425147e64b1d200c09862869188b8f95e52454f7b8e97
+  metadata.gz: 834735162f5c696d940e546b1908bca87a2b0c8e93d3f20247b1468404071b56
+  data.tar.gz: 6083f1cfaf96c4857c43e580398c512e00589f8e0ef9b799f365d2719d8c1848
 SHA512:
-  metadata.gz: 17187f65ff16035e72fc7d7e0b9468bd970d337b1f8173fbc2dde15f420ad406aa33ecb440b4b65e0dffb921279660fdedb48b4bb320ce3e4e9a411eec3a21da
-  data.tar.gz: 8c8d0f0c86af8a97c18dc794e69b84634421607a7e6715120b90fd3d9f74bdd1848a5c422598dbc06fdb0ea7ce4ac474e76b761ec7e2243fdb87b2aa812af292
+  metadata.gz: 39f8e38f80a35a4d019bed707745d7835fcdc92e8e162dd90a492ce46c711016cb73789ff57d384ac763f8514a5f5749ccc4f1db75a9d4cad4e96a7512ce8be4
+  data.tar.gz: 4c92cbd6cf2dcb597bd6a265cd7c5a892af3ea504a220e82a7cbcc5e06ef421703ead862e0ba5b6ab88b7633050fe93966befc78c50a76c4f5e23155d65c8a7c

data/.yardopts

@@ -0,0 +1 @@
+--main README.md --markup=markdown {lib}/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.2.3
+
+- JSI v0.7.0
+
+# v0.2.2
+
+- Ur::Weblink
+- Ruby 3
+
 # v0.2.1
 
 - JSI v0.6.0

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ur' unless Object.const_defined?(:Ur)
+require 'strscan'
 
 module Ur
   # Ur::ContentType represents a Content-Type header field.
@@ -154,21 +155,21 @@ module Ur
     # @param 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]
     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]
     def suffix?(other_suffix)
-      suffix && suffix.casecmp?(other_suffix)
+      suffix ? suffix.casecmp?(other_suffix) : false
     end
 
     SOME_TEXT_SUBTYPES = %w(
@@ -215,55 +216,55 @@ module Ur
     # 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
 
     # 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
 
     # is the 'type' portion of our media type 'text'
     # @return [Boolean]
     def type_text?
-      type && type.casecmp?('text')
+      type ? type.casecmp?('text') : false
     end
 
     # is the 'type' portion of our media type 'image'
     # @return [Boolean]
     def type_image?
-      type && type.casecmp?('image')
+      type ? type.casecmp?('image') : false
     end
 
     # is the 'type' portion of our media type 'audio'
     # @return [Boolean]
     def type_audio?
-      type && type.casecmp?('audio')
+      type ? type.casecmp?('audio') : false
     end
 
     # is the 'type' portion of our media type 'video'
     # @return [Boolean]
     def type_video?
-      type && type.casecmp?('video')
+      type ? type.casecmp?('video') : false
     end
 
     # is the 'type' portion of our media type 'application'
     # @return [Boolean]
     def type_application?
-      type && type.casecmp?('application')
+      type ? type.casecmp?('application') : false
     end
 
     # is the 'type' portion of our media type 'message'
     # @return [Boolean]
     def type_message?
-      type && type.casecmp?('message')
+      type ? type.casecmp?('message') : false
     end
 
     # 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/version.rb

@@ -1 +1 @@
-UR_VERSION = "0.2.1".freeze
+UR_VERSION = "0.2.3".freeze

data/lib/ur/weblink.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'ur' unless Object.const_defined?(:Ur)
+require 'strscan'
+
+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 = /"([^"]*)"/
+
+      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

@@ -19,6 +19,7 @@ module Ur
   autoload :FaradayMiddleware, 'ur/middleware'
   autoload :RackMiddleware, 'ur/middleware'
   autoload :Faraday, 'ur/faraday'
+  autoload :Weblink, 'ur/weblink'
 
   Request = self.properties['request']
   Response = self.properties['response']
@@ -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/ur.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/ur/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ur"
+  spec.version       = UR_VERSION
+  spec.authors       = ["Ethan"]
+  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"
+
+  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.7"
+  spec.add_dependency "addressable", "~> 2.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ur
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Ethan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2023-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +48,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE.md
 - README.md
@@ -62,12 +63,14 @@ files:
 - lib/ur/response.rb
 - lib/ur/sub_ur.rb
 - lib/ur/version.rb
+- lib/ur/weblink.rb
 - resources/ur.schema.yml
+- ur.gemspec
 homepage: https://github.com/notEthan/ur
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: 'ur: unified request representation'
 test_files: []