ur 0.0.4 → 0.2.1

data/lib/ur/request_and_response.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
+module Ur
+  # functionality common to Request and Response
   module RequestAndResponse
+    # functionality for handling request/response entities from Faraday
     module FaradayEntity
+      # @param env [Faraday::Env] faraday env passed to middleware #call
       def set_body_from_faraday(env)
         if env[:raw_body].respond_to?(:to_str)
           self.body = env[:raw_body].to_str.dup
@@ -20,20 +25,38 @@ class Ur
     end
     include FaradayEntity
 
-    def content_type_attrs
-      return @content_type_attrs if instance_variable_defined?(:@content_type_attrs)
-      @content_type_attrs = ContentTypeAttrs.new(content_type)
-    end
-
+    # 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 v if k =~ /\Acontent[-_]type\z/i
+        return ContentType.new(v) if k =~ /\Acontent[-_]type\z/i
       end
       nil
     end
 
+    # the media type of the content type
     def media_type
-      content_type_attrs.media_type
+      content_type ? content_type.media_type : nil
+    end
+
+    # is our content type JSON?
+    # @return [Boolean]
+    def json?
+      content_type && content_type.json?
+    end
+
+    # is our content type XML?
+    # @return [Boolean]
+    def xml?
+      content_type && content_type.xml?
+    end
+
+    # is our content type `x-www-form-urlencoded`?
+    # @return [Boolean]
+    def form_urlencoded?
+      content_type && content_type.form_urlencoded?
     end
   end
 end

data/lib/ur/response.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
-  class Response
+module Ur
+  module Response
     include RequestAndResponse
     include SubUr
 

data/lib/ur/sub_ur.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
+module Ur
   module SubUr
     def ur
-      parents.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.0.4".freeze
+UR_VERSION = "0.2.1".freeze

data/lib/ur.rb

@@ -1,46 +1,16 @@
+# frozen_string_literal: true
+
 require "ur/version"
 
 require 'jsi'
 require 'time'
 require 'addressable/uri'
+require 'pathname'
+require 'yaml'
 
-Ur = JSI.class_for_schema({
-  id: 'https://schemas.ur.unth.net/ur',
-  type: 'object',
-  properties: {
-    bound: {
-      type: 'string',
-      description: %q([rfc2616] Inbound and outbound refer to the request and response paths for messages: "inbound" means "traveling toward the origin server", and "outbound" means "traveling toward the user agent"),
-      enum: ['inbound', 'outbound'],
-    },
-    request: {
-      type: 'object',
-      properties: {
-        method: {type: 'string', description: 'HTTP ', example: 'POST'},
-        uri: {type: 'string', example: 'https://example.com/foo?bar=baz'},
-        headers: {type: 'object'},
-        body: {type: 'string'},
-      },
-    },
-    response: {
-      type: 'object',
-      properties: {
-        status: {type: 'integer', example: 200},
-        headers: {type: 'object'},
-        body: {type: 'string'},
-      },
-    },
-    processing: {
-      type: 'object',
-      properties: {
-        began_at_s: {type: 'string'},
-        duration: {type: 'number'},
-        tags: {type: 'array', items: {type: 'string'}}
-      },
-    },
-  },
-})
-class Ur
+UR_ROOT = Pathname.new(__FILE__).dirname.parent.expand_path
+Ur = JSI.new_schema_module(YAML.load_file(UR_ROOT.join('resources/ur.schema.yml')))
+module Ur
   VERSION = UR_VERSION
 
   autoload :SubUr, 'ur/sub_ur'
@@ -50,17 +20,29 @@ class Ur
   autoload :RackMiddleware, 'ur/middleware'
   autoload :Faraday, 'ur/faraday'
 
-  Request = JSI.class_for_schema(self.schema['properties']['request'])
-  Response = JSI.class_for_schema(self.schema['properties']['response'])
-  Processing = JSI.class_for_schema(self.schema['properties']['processing'])
+  Request = self.properties['request']
+  Response = self.properties['response']
+  Metadata = self.properties['metadata']
   require 'ur/request'
   require 'ur/response'
-  require 'ur/processing'
+  require 'ur/metadata'
 
-  autoload :ContentTypeAttrs, 'ur/content_type_attrs'
+  autoload :ContentType, 'ur/content_type'
 
   class << self
-    def from_rack_request(request_env)
+    def new(instance = {}, schemas: Set[], **options)
+      unless instance.respond_to?(:to_hash)
+        raise(TypeError, "expected hash for ur instance. got: #{instance.pretty_inspect.chomp}")
+      end
+
+      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?
+      end
+    end
+
+    def from_rack_request(request_env, **options)
       if request_env.is_a?(Rack::Request)
         rack_request = request_env
         env = request_env.env
@@ -69,9 +51,7 @@ class Ur
         env = request_env
       end
 
-      new({'bound' => 'inbound'}).tap do |ur|
-        ur.processing.begin!
-
+      new({'bound' => 'inbound'}, options).tap do |ur|
         ur.request['method'] = rack_request.request_method
 
         ur.request.addressable_uri = Addressable::URI.new(
@@ -101,9 +81,8 @@ class Ur
       end
     end
 
-    def from_faraday_request(request_env, logger: nil)
-      new({'bound' => 'outbound'}).tap do |ur|
-        ur.processing.begin!
+    def from_faraday_request(request_env, **options)
+      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]
@@ -112,19 +91,13 @@ class Ur
     end
   end
 
-  def initialize(ur = {}, **opt, &b)
-    super(ur, **opt, &b)
-    unless instance.respond_to?(:to_hash)
-      raise(TypeError, "expected hash argument. got: #{ur.pretty_inspect.chomp}")
-    end
-    self.request = {} if self.request.nil?
-    self.response = {} if self.response.nil?
-    self.processing = {} if self.processing.nil?
-  end
-
-  def logger=(logger)
+  # Ur#logger_tags applies tags from a tagged logger to this ur's metadata.
+  # note: ur does not log anything and this logger is not stored.
+  # @param [logger] a tagged logger
+  # @return [void]
+  def logger_tags(logger)
     if logger && logger.formatter.respond_to?(:current_tags)
-      processing.tags = logger.formatter.current_tags.dup
+      metadata.tags = logger.formatter.current_tags.dup
     end
   end
 
@@ -136,8 +109,6 @@ class Ur
     response.body = response_body.to_enum.to_a.join('')
 
     response_body_proxy = ::Rack::BodyProxy.new(response_body) do
-      processing.finish!
-
       yield
     end
     [status, response_headers, response_body_proxy]
@@ -148,7 +119,6 @@ class Ur
       response.status = response_env[:status]
       response.headers = response_env[:response_headers]
       response.set_body_from_faraday(response_env)
-      processing.finish!
 
       yield(response_env)
     end

data/resources/ur.schema.yml

@@ -0,0 +1,51 @@
+$schema: http://json-schema.org/draft-07/schema
+$id: https://schemas.ur.unth.net/ur
+type: object
+properties:
+  bound:
+    type: string
+    description: '[RFC7230] The terms "inbound" and "outbound" are used to describe directional requirements in relation to the request route: "inbound" means toward the origin server and "outbound" means toward the user agent.'
+    enum:
+    - inbound
+    - outbound
+  request:
+    type: object
+    properties:
+      method:
+        type: string
+        description: '[RFC7230] The method token indicates the request method to be performed on the target resource.'
+        example: POST
+      uri:
+        type: string
+        format: uri
+        example: https://example.com/foo?bar=baz
+      headers:
+        type: object
+      body:
+        type: string
+  response:
+    type: object
+    properties:
+      status:
+        type: integer
+        description: >
+          The status-code element is a 3-digit integer code describing the
+          result of the server's attempt to understand and satisfy the client's
+          corresponding request.
+        example: 200
+      headers:
+        type: object
+      body:
+        type: string
+  metadata:
+    type: object
+    properties:
+      began_at_s:
+        type: string
+        format: date-time
+      duration:
+        type: number
+      tags:
+        type: array
+        items:
+          type: string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ur
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Ethan
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -38,168 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 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.
 email:
-- ethan@unth
+- ethan.ur@unth.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".simplecov"
-- ".yardopts"
 - CHANGELOG.md
-- LICENSE.txt
+- LICENSE.md
 - README.md
-- Rakefile.rb
 - lib/ur.rb
-- lib/ur/content_type_attrs.rb
+- lib/ur/content_type.rb
 - lib/ur/faraday.rb
 - lib/ur/faraday/yield_ur.rb
+- lib/ur/metadata.rb
 - lib/ur/middleware.rb
-- lib/ur/processing.rb
 - lib/ur/request.rb
 - lib/ur/request_and_response.rb
 - lib/ur/response.rb
 - lib/ur/sub_ur.rb
 - lib/ur/version.rb
-- test/test_helper.rb
-- test/ur_faraday_test.rb
-- test/ur_processing_test.rb
-- test/ur_rack_test.rb
-- test/ur_test.rb
-- ur.gemspec
+- resources/ur.schema.yml
 homepage: https://github.com/notEthan/ur
 licenses:
-- MIT
+- LGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -216,15 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: 'ur: unified request representation'
-test_files:
-- test/test_helper.rb
-- test/ur_faraday_test.rb
-- test/ur_processing_test.rb
-- test/ur_rack_test.rb
-- test/ur_test.rb
-- ".simplecov"
+test_files: []

data/.simplecov

@@ -1 +0,0 @@
-SimpleCov.start

data/.yardopts

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Ethan
-
-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/Rakefile.rb

@@ -1,9 +0,0 @@
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test

data/lib/ur/content_type_attrs.rb

@@ -1,83 +0,0 @@
-require 'ur' unless Object.const_defined?(:Ur)
-
-class Ur
-  # parses attributes out of content type header
-  class ContentTypeAttrs
-    def initialize(content_type)
-      raise(ArgumentError) unless content_type.nil? || content_type.respond_to?(:to_str)
-      content_type = content_type.to_str if content_type
-      @media_type = (content_type.split(/\s*[;]\s*/, 2).first if content_type)
-      @media_type.strip! if @media_type
-      @content_type = content_type
-      @parsed = false
-      @attributes = Hash.new { |h,k| h[k] = [] }
-      catch(:unparseable) do
-        throw(:unparseable) unless content_type
-        uri_parser = URI.const_defined?(:Parser) ? URI::Parser.new : URI
-        scanner = StringScanner.new(content_type)
-        scanner.scan(/.*;\s*/) || throw(:unparseable)
-        while scanner.scan(/(\w+)=("?)([^"]*)("?)\s*(,?)\s*/)
-          key = scanner[1]
-          quote1 = scanner[2]
-          value = scanner[3]
-          quote2 = scanner[4]
-          comma_follows = !scanner[5].empty?
-          throw(:unparseable) unless quote1 == quote2
-          throw(:unparseable) if !comma_follows && !scanner.eos?
-          @attributes[uri_parser.unescape(key)] << uri_parser.unescape(value)
-        end
-        throw(:unparseable) unless scanner.eos?
-        @parsed = true
-      end
-    end
-
-    attr_reader :content_type, :media_type
-
-    def parsed?
-      @parsed
-    end
-
-    def [](key)
-      @attributes[key]
-    end
-
-    def text?
-      # ordered hash by priority mapping types to binary or text
-      # regexps will have \A and \z added 
-      types = {
-        %r(image/.*) => :binary,
-        %r(audio/.*) => :binary,
-        %r(video/.*) => :binary,
-        %r(model/.*) => :binary,
-        %r(text/.*) => :text,
-        %r(message/.*) => :text,
-        %r(application/(.+\+)?json) => :text,
-        %r(application/(.+\+)?xml) => :text,
-        %r(model/(.+\+)?xml) => :text,
-        'application/x-www-form-urlencoded' => :text,
-        'application/javascript' => :text,
-        'application/ecmascript' => :text,
-        'application/octet-stream' => :binary,
-        'application/ogg' => :binary,
-        'application/pdf' => :binary,
-        'application/postscript' => :binary,
-        'application/zip' => :binary,
-        'application/gzip' => :binary,
-        'application/vnd.apple.pkpass' => :binary,
-      }
-      types.each do |match, type|
-        matched = match.is_a?(Regexp) ? media_type =~ %r(\A#{match.source}\z) : media_type == match
-        if matched
-          return type == :text
-        end
-      end
-      # fallback (unknown or not given) assume that unknown content types are binary but omitted 
-      # content-type means text
-      if content_type && content_type =~ /\S/
-        return false
-      else
-        return true
-      end
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,22 +0,0 @@
-proc { |p| $:.unshift(p) unless $:.any? { |lp| File.expand_path(lp) == p } }.call(File.expand_path('../lib', File.dirname(__FILE__)))
-
-require 'simplecov'
-require 'byebug'
-
-# NO EXPECTATIONS
-ENV["MT_NO_EXPECTATIONS"] = ''
-
-require 'minitest/autorun'
-require 'minitest/reporters'
-Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
-
-class UrSpec < Minitest::Spec
-  def assert_json_equal(exp, act, *a)
-    assert_equal(JSI::Typelike.as_json(exp), JSI::Typelike.as_json(act), *a)
-  end
-end
-
-# register this to be the base class for specs instead of Minitest::Spec
-Minitest::Spec.register_spec_type(//, UrSpec)
-
-require 'ur'