ur 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20d9f65430cb5e9571314e578ec2c6ec838e694eef3970d02005e4f1589db0d0
-  data.tar.gz: e3bcf5550424177a7036ca7eafe91d32ed73c4b7a2c855dfbabd36d7606bebbd
+  metadata.gz: '08e517b90ad97d890764bc228d8836e7e48d7f8250ed7c3a4878368b77b2deb2'
+  data.tar.gz: e87aedb3a622a5606bff0370cc1a06f43d98be53488389c1902e989226760cd1
 SHA512:
-  metadata.gz: fbd253924bb53b4f78a368c97b51ec643694faa7770b5b1d1931791deb14f5d5bdbedff7d19197f478da540105c52ebea6b4eb3397cfa799c50f13c985b980a7
-  data.tar.gz: e5a7adeeefbb79feeb23cde88fe441ba6bab2520dd37485ad456d2f62c66d5e7eb0638d6b9da7156eaf28a0344a822dce9dd5bdfec11059e0c7ba8d13883fcc8
+  metadata.gz: '069f50e6768b41beb13830308fd3a3d18845c32fc38f6e95755b8f929ba88e20efcfce8f84abf50ed393a93f9c2971bb7b280e5793d43098c06dc034f136487c'
+  data.tar.gz: 42c005bf4853f4bb946a2bd143696c84fa84c6f933b71a6425505722aab150f290ab21265ac2b6e9fdaa313e0207becb46f5a14ff20a7cd2c18e4daa53d12084

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.2.0
+
+- Ur uses JSI schema modules instead of classes
+
 # v0.1.1
 - minor fixes
 

data/lib/ur.rb

@@ -8,8 +8,8 @@ require 'addressable/uri'
 require 'pathname'
 
 UR_ROOT = Pathname.new(__FILE__).dirname.parent.expand_path
-Ur = JSI.class_for_schema(YAML.load_file(UR_ROOT.join('resources/ur.schema.yml')))
-class Ur
+Ur = JSI::Schema.new(YAML.load_file(UR_ROOT.join('resources/ur.schema.yml'))).jsi_schema_module
+module Ur
   VERSION = UR_VERSION
 
   autoload :SubUr, 'ur/sub_ur'
@@ -19,9 +19,9 @@ 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'])
-  Metadata = JSI.class_for_schema(self.schema['properties']['metadata'])
+  Request = self.schema.properties['request'].jsi_schema_module
+  Response = self.schema.properties['response'].jsi_schema_module
+  Metadata = self.schema.properties['metadata'].jsi_schema_module
   require 'ur/request'
   require 'ur/response'
   require 'ur/metadata'
@@ -29,7 +29,20 @@ class Ur
   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
+
+      ur_class = JSI.class_for_schemas(Set[schema] + schemas)
+      ur_class.new(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
@@ -38,7 +51,7 @@ class Ur
         env = request_env
       end
 
-      new({'bound' => 'inbound'}).tap do |ur|
+      new({'bound' => 'inbound'}, options).tap do |ur|
         ur.request['method'] = rack_request.request_method
 
         ur.request.addressable_uri = Addressable::URI.new(
@@ -68,8 +81,8 @@ class Ur
       end
     end
 
-    def from_faraday_request(request_env)
-      new({'bound' => 'outbound'}).tap do |ur|
+    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]
@@ -78,16 +91,6 @@ 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.metadata = {} if self.metadata.nil?
-  end
-
   # 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

data/lib/ur/content_type.rb

@@ -2,7 +2,7 @@
 
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
+module Ur
   # Ur::ContentType represents a Content-Type header field.
   # it parses the media type and its components, as well as any parameters.
   #

data/lib/ur/faraday.rb

@@ -2,7 +2,7 @@
 
 require 'faraday'
 
-class Ur
+module Ur
   module Faraday
     autoload :YieldUr, 'ur/faraday/yield_ur'
   end

data/lib/ur/faraday/yield_ur.rb

@@ -1,24 +1,12 @@
 # frozen_string_literal: true
 
-class Ur
+module Ur
   module Faraday
     # Faraday middleware which yields an Ur to the given block
     class YieldUr < ::Ur::FaradayMiddleware
-      def initialize(app, options = {}, &block)
+      def initialize(app, **options, &block)
         raise(ArgumentError, "no block given to yield ur") unless block
-        raise(TypeError, "options must be a Hash") unless options.respond_to?(:to_hash)
-        @app = app
-        @options = options
-        @yield_to = block
-      end
-
-      def call(request_env)
-        ur = (@options[:ur_class] || Ur).from_faraday_request(request_env)
-        begin_request(ur)
-        ur.faraday_on_complete(@app, request_env) do |response_env|
-          finish_request(ur)
-          @yield_to.call(ur)
-        end
+        super(app, options.merge(after_response: block))
       end
     end
   end

data/lib/ur/metadata.rb

@@ -2,8 +2,8 @@
 
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
-  class Metadata
+module Ur
+  module Metadata
     include SubUr
 
     def began_at
@@ -17,8 +17,8 @@ class Ur
 
     # sets began_at from the current time
     def begin!
-      self.began_at ||= Time.now
-      self.began_at_ns ||= Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+      self.began_at = Time.now
+      self.began_at_ns = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
     end
 
     # sets the duration from the current time and began_at

data/lib/ur/middleware.rb

@@ -2,7 +2,7 @@
 
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
+module Ur
   module Middleware
     def initialize(app, options = {})
       @app = app
@@ -30,7 +30,7 @@ class Ur
   class FaradayMiddleware < ::Faraday::Middleware
     include Ur::Middleware
     def call(request_env)
-      ur = Ur.from_faraday_request(request_env)
+      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 @@ class Ur
   class RackMiddleware
     include Ur::Middleware
     def call(env)
-      ur = Ur.from_rack_request(env)
+      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.rb

@@ -2,8 +2,8 @@
 
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
-  class Request
+module Ur
+  module Request
     include RequestAndResponse
     include SubUr
 

data/lib/ur/request_and_response.rb

@@ -2,7 +2,7 @@
 
 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

data/lib/ur/response.rb

@@ -2,8 +2,8 @@
 
 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

@@ -2,10 +2,10 @@
 
 require 'ur' unless Object.const_defined?(:Ur)
 
-class Ur
+module Ur
   module SubUr
     def ur
-      parents.detect { |p| p.is_a?(::Ur) }
+      parent_jsis.detect { |p| p.is_a?(::Ur) }
     end
   end
 end

data/lib/ur/version.rb

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

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_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
@@ -92,7 +92,7 @@ describe 'Ur' do
           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

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files   = `git ls-files -z test`.split("\x0") + ['.simplecov']
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", ">= 0.2.0", "< 0.4.0"
+  spec.add_dependency "jsi", "~> 0.4"
   spec.add_dependency "addressable", "~> 2.0"
   spec.add_development_dependency "rack"
   spec.add_development_dependency "rack-test"

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ur
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement