ur 0.0.2 → 0.2.0

data/test/test_helper.rb

@@ -11,9 +11,20 @@ require 'minitest/reporters'
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
 class UrSpec < Minitest::Spec
+  if ENV['UR_TEST_ALPHA']
+    # :nocov:
+    define_singleton_method(:test_order) { :alpha }
+    # :nocov:
+  end
+
   def assert_json_equal(exp, act, *a)
     assert_equal(JSI::Typelike.as_json(exp), JSI::Typelike.as_json(act), *a)
   end
+
+  def assert_equal exp, act, msg = nil
+    msg = message(msg, E) { diff exp, act }
+    assert exp == act, msg
+  end
 end
 
 # register this to be the base class for specs instead of Minitest::Spec

data/test/ur_faraday_test.rb

@@ -9,11 +9,11 @@ describe 'Ur faraday integration' do
       builder.use(Ur::FaradayMiddleware,
         after_response: -> (ur_) { ur = ur_ },
       )
-      builder.use(Faraday::Adapter::Rack, -> (env) { [200, {'Content-Type' => 'text/plain'}, ['ᚒ']] })
+      builder.adapter(:rack, -> (env) { [200, {'Content-Type' => 'text/plain'}, ['ᚒ']] })
     end
     res = faraday_conn.get('/')
     assert_equal('ᚒ', res.body)
-    assert_instance_of(Ur, ur)
+    assert_kind_of(Ur, ur)
     assert_equal('get', ur.request['method'])
     assert_equal('text/plain', ur.response.headers['Content-Type'])
     assert_equal('ᚒ', ur.response.body)
@@ -25,11 +25,11 @@ describe 'Ur faraday integration' do
       builder.use(Ur::FaradayMiddleware,
         after_response: -> (ur_) { ur = ur_ },
       )
-      builder.use(Faraday::Adapter::Rack, -> (env) { [200, {'Content-Type' => 'text/plain'}, ['☺']] })
+      builder.adapter(:rack, -> (env) { [200, {'Content-Type' => 'text/plain'}, ['☺']] })
     end
     res = faraday_conn.post('/', StringIO.new('hello!'))
     assert_equal('☺', res.body)
-    assert_instance_of(Ur, ur)
+    assert_kind_of(Ur, ur)
     assert_equal('post', ur.request['method'])
     assert_equal('hello!', ur.request.body)
     assert_equal('text/plain', ur.response.headers['Content-Type'])
@@ -44,11 +44,11 @@ describe 'Ur faraday integration' do
         after_response: -> (ur_) { ur = ur_ },
       )
       builder.response :json, preserve_raw: true
-      builder.use(Faraday::Adapter::Rack, -> (env) { [200, {'Content-Type' => 'application/json'}, ['{}']] })
+      builder.adapter(:rack, -> (env) { [200, {'Content-Type' => 'application/json'}, ['{}']] })
     end
     res = faraday_conn.post('/', {'a' => 'b'})
     assert_equal({}, res.body)
-    assert_instance_of(Ur, ur)
+    assert_kind_of(Ur, ur)
     assert_equal('post', ur.request['method'])
     assert_equal('{"a":"b"}', ur.request.body)
     assert_equal('application/json', ur.response.headers['Content-Type'])
@@ -63,11 +63,11 @@ describe 'Ur faraday integration' do
       )
       builder.request :json
       builder.response :json
-      builder.use(Faraday::Adapter::Rack, -> (env) { [200, {'Content-Type' => 'application/json'}, ['{}']] })
+      builder.adapter(:rack, -> (env) { [200, {'Content-Type' => 'application/json'}, ['{}']] })
     end
     res = faraday_conn.post('/', {'a' => 'b'})
     assert_equal({}, res.body)
-    assert_instance_of(Ur, ur)
+    assert_kind_of(Ur, ur)
     assert_equal('post', ur.request['method'])
     assert_nil(ur.request.body) # no good
     assert_json_equal({"a" => "b"}, ur.request['body_parsed']) # best we get here

data/test/ur_metadata_test.rb

@@ -0,0 +1,11 @@
+require_relative 'test_helper'
+
+describe 'Ur metadata' do
+  it 'sets duration from began_at' do
+    ur = Ur.new
+    ur.metadata.began_at = Time.now
+    ur.metadata.finish!
+    assert_instance_of(Float, ur.metadata.duration)
+    assert_operator(ur.metadata.duration, :>, 0)
+  end
+end

data/test/ur_rack_test.rb

@@ -10,8 +10,6 @@ describe 'Ur rack integration' do
     assert_equal('bar', ur.request.headers['foo'])
     assert_equal('https://ur.unth.net/', ur.request.uri)
     assert(ur.response.empty?)
-    assert_instance_of(Time, ur.processing.began_at)
-    assert_nil(ur.processing.duration)
     assert(ur.validate)
   end
   it 'builds from a rack request' do
@@ -22,8 +20,6 @@ describe 'Ur rack integration' do
     assert_equal('bar', ur.request.headers['foo'])
     assert_equal('https://ur.unth.net/', ur.request.uri)
     assert(ur.response.empty?)
-    assert_instance_of(Time, ur.processing.began_at)
-    assert_nil(ur.processing.duration)
     assert(ur.validate)
   end
 end

data/test/ur_test.rb

@@ -8,7 +8,7 @@ describe 'Ur' do
   end
 
   it 'initializes' do
-    Ur.new({})
+    Ur.new_jsi({})
   end
 
   it 'would prefer not to initialize' do
@@ -37,8 +37,8 @@ describe 'Ur' do
         assert_equal('bar', ur.request.headers['foo'])
         assert_equal('https://ur.unth.net/', ur.request.uri)
         assert(ur.response.empty?)
-        assert_instance_of(Time, ur.processing.began_at)
-        assert_nil(ur.processing.duration)
+        assert_nil(ur.metadata.began_at)
+        assert_nil(ur.metadata.duration)
         assert(ur.validate)
       end,
       after_response: -> (ur) do
@@ -51,10 +51,10 @@ describe 'Ur' do
         assert_equal(200, ur.response.status)
         assert_equal('text/plain', ur.response.headers['Content-Type'])
         assert_equal('ᚒ', ur.response.body)
-        assert_instance_of(Time, ur.processing.began_at)
-        assert_instance_of(Float, ur.processing.duration)
-        assert_operator(ur.processing.duration, :>, 0)
-        assert_equal(['ur_test_rack'], ur.processing.tags.to_a)
+        assert_instance_of(Time, ur.metadata.began_at)
+        assert_instance_of(Float, ur.metadata.duration)
+        assert_operator(ur.metadata.duration, :>, 0)
+        assert_equal(['ur_test_rack'], ur.metadata.tags.to_a)
         assert(ur.validate)
       end,
     )
@@ -71,8 +71,8 @@ describe 'Ur' do
           assert_equal('https://ur.unth.net/', ur.request.uri)
           assert_equal(Addressable::URI.parse('https://ur.unth.net/'), ur.request.addressable_uri)
           assert(ur.response.empty?)
-          assert_instance_of(Time, ur.processing.began_at)
-          assert_nil(ur.processing.duration)
+          assert_nil(ur.metadata.began_at)
+          assert_nil(ur.metadata.duration)
           assert(ur.validate)
         end,
         after_response: -> (ur) do
@@ -85,14 +85,14 @@ describe 'Ur' do
           assert_equal(200, ur.response.status)
           assert_equal('text/plain', ur.response.headers['Content-Type'])
           assert_equal('ᚒ', ur.response.body)
-          assert_instance_of(Time, ur.processing.began_at)
-          assert_instance_of(Float, ur.processing.duration)
-          assert_operator(ur.processing.duration, :>, 0)
-          assert_equal(['ur_test_faraday'], ur.processing.tags.to_a)
+          assert_instance_of(Time, ur.metadata.began_at)
+          assert_instance_of(Float, ur.metadata.duration)
+          assert_operator(ur.metadata.duration, :>, 0)
+          assert_equal(['ur_test_faraday'], ur.metadata.tags.to_a)
           assert(ur.validate)
         end,
       )
-      builder.use(Faraday::Adapter::Rack, rack_app)
+      builder.adapter(:rack, rack_app)
     end
     res = faraday_conn.get('/', nil, {'Foo' => 'bar'})
     assert(called_rack_before_request)

data/ur.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ur/version"
@@ -12,32 +11,23 @@ Gem::Specification.new do |spec|
   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       = "MIT"
+  spec.license       = "LGPL-3.0"
 
-  ignore_files = %w(.gitignore .travis.yml Gemfile test)
+  ignore_files   = %w(.gitignore .travis.yml Gemfile test)
   ignore_files_re = %r{\A(#{ignore_files.map { |f| Regexp.escape(f) }.join('|')})(/|\z)}
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  Dir.chdir(File.expand_path('..', __FILE__)) do
-    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',
-    ]
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "~> 0.0.3"
+  spec.add_dependency "jsi", "~> 0.4"
   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 "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ur
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -108,48 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -191,29 +177,32 @@ 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
+- resources/icons/LGPL-3.0.png
+- resources/ur.schema.yml
+- test/content_type_test.rb
 - test/test_helper.rb
 - test/ur_faraday_test.rb
-- test/ur_processing_test.rb
+- test/ur_metadata_test.rb
 - test/ur_rack_test.rb
 - test/ur_test.rb
 - ur.gemspec
 homepage: https://github.com/notEthan/ur
 licenses:
-- MIT
+- LGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -230,15 +219,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: 'ur: unified request representation'
 test_files:
+- test/content_type_test.rb
 - test/test_helper.rb
 - test/ur_faraday_test.rb
-- test/ur_processing_test.rb
+- test/ur_metadata_test.rb
 - test/ur_rack_test.rb
 - test/ur_test.rb
 - ".simplecov"

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/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