ur 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cd35887d4f337c01a55526c85dec4d0473ed24532d920960890cccc44f3f52'
-  data.tar.gz: e6cb70fe2d62dd42864c6fd6b2b6cf7c9ebf3f0c73744e0fa8a952618e1d8b1e
+  metadata.gz: 85e941c9b4dad6807b7635acc90b762e4f096f38f8f981511be120e42effc7f9
+  data.tar.gz: cbca689430e05b3865b8572dacbc114201c4af217b0e893fade40ae2a74f3b12
 SHA512:
-  metadata.gz: 3e1b5884244f923e22e6570d3e87ce7b3d70771987845bff06da886bb86ed9d29623cbdbf6c55ed943b53529e1506d53f5b995704de177a279c566e8770986f0
-  data.tar.gz: 040554fff56b914de9343fb4abd7e5175557224c34632385efaa5794125587f1ea4ae31f5cf8c9b761d20d8b881a320abcee4ebd49cd2614f25680dcce534d09
+  metadata.gz: e45319855396792763e515a96d21ad3e56475461c9b8733b4d0dfb97dee9a2e3efac7107b0f58a510003ab70a17e64c367dde594ea8d0e3acd5a771be6a47044
+  data.tar.gz: b7d0f97850df360137870edefe21f321b9f919f84d1ec9be65c45e30461297b6e725d949e9051de6c7f87bd3d9bef25be1cb7479fc20356f8dfb2fd7cf79d58f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.0.2
+
+- module SubUr common to Ur::Request, Response, Processing
+- Ur methods prefixed with sub-ur names delegate, e.g. Ur#request_uri delegates to ur.request.uri
+- Ur::Response#success?, #client_error?, #server_error?
+- Ur::Request and Ur::Response content_type attributes and media_type
+- Ur::Faraday::YieldUr middleware
+- bugfixes and refactoring
+
 # v0.0.1
 
 - Ur, Ur::Request, Ur::Response, Ur::Processing

data/lib/ur.rb

@@ -43,10 +43,12 @@ Ur = JSI.class_for_schema({
 class Ur
   VERSION = UR_VERSION
 
+  autoload :SubUr, 'ur/sub_ur'
   autoload :RequestAndResponse, 'ur/request_and_response'
   autoload :Middleware, 'ur/middleware'
   autoload :FaradayMiddleware, 'ur/middleware'
   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'])
@@ -55,6 +57,8 @@ class Ur
   require 'ur/response'
   require 'ur/processing'
 
+  autoload :ContentTypeAttrs, 'ur/content_type_attrs'
+
   class << self
     def from_rack_request(request_env)
       if request_env.is_a?(Rack::Request)
@@ -65,9 +69,8 @@ class Ur
         env = request_env
       end
 
-      Ur.new({}).tap do |ur|
+      new({'bound' => 'inbound'}).tap do |ur|
         ur.processing.begin!
-        ur.bound = 'inbound'
         ur.request['method'] = rack_request.request_method
         ur.request.headers = env.map do |(key, value)|
           http_match = key.match(/\AHTTP_/)
@@ -95,9 +98,8 @@ class Ur
     end
 
     def from_faraday_request(request_env, logger: nil)
-      Ur.new({}).tap do |ur|
+      new({'bound' => 'outbound'}).tap do |ur|
         ur.processing.begin!
-        ur.bound = 'outbound'
         ur.request['method'] = request_env[:method].to_s
         ur.request.headers = request_env[:request_headers]
         ur.request.uri = request_env[:url].normalize.to_s
@@ -106,8 +108,9 @@ class Ur
     end
   end
 
-  def initialize(ur = {}, *a, &b)
-    super(ur, *a, &b)
+  def initialize(ur = {}, **opt, &b)
+    ur = JSI::JSON::Node.new_doc(ur) unless ur.is_a?(JSI::JSON::Node)
+    super(ur, **opt, &b)
     unless instance.respond_to?(:to_hash)
       raise(TypeError, "expected hash argument. got: #{ur.pretty_inspect.chomp}")
     end
@@ -147,4 +150,18 @@ class Ur
       yield(response_env)
     end
   end
+
+  # define delegator sort of methods for nested property names, eg.
+  #    ur.request_uri
+  # this makes it easier to use Symbol#to_proc, eg urs.map(&:request_uri)
+  # instead of urs.map(&:request).map(&:uri)
+  schema['properties'].each do |property_name, property_schema|
+    if property_schema['type'] == 'object' && property_schema['properties']
+      property_schema['properties'].each_key do |property_property_name|
+        define_method("#{property_name}_#{property_property_name}") do
+          self[property_name][property_property_name]
+        end
+      end
+    end
+  end
 end

data/lib/ur/content_type_attrs.rb

@@ -0,0 +1,83 @@
+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/lib/ur/faraday.rb

@@ -0,0 +1,9 @@
+require 'faraday'
+
+class Ur
+  module Faraday
+    autoload :YieldUr, 'ur/faraday/yield_ur'
+  end
+end
+
+Faraday::Response.register_middleware(:yield_ur => proc { Ur::Faraday::YieldUr })

data/lib/ur/faraday/yield_ur.rb

@@ -0,0 +1,19 @@
+class Ur
+  module Faraday
+    class YieldUr < ::Faraday::Middleware
+      def initialize(app, options = {}, &block)
+        @app = app
+        @options = options
+        @yield_to = block
+      end
+
+      def call(request_env)
+        ur = Scorpio::Ur.from_faraday_request(request_env)
+        ur.logger = @options[:logger]
+        ur.faraday_on_complete(@app, request_env) do |response_env|
+          @yield_to.call(ur)
+        end
+      end
+    end
+  end
+end

data/lib/ur/processing.rb

@@ -2,6 +2,8 @@ require 'ur' unless Object.const_defined?(:Ur)
 
 class Ur
   class Processing
+    include SubUr
+
     def began_at
       began_at_s ? Time.parse(began_at_s) : nil
     end

data/lib/ur/request.rb

@@ -3,6 +3,7 @@ require 'ur' unless Object.const_defined?(:Ur)
 class Ur
   class Request
     include RequestAndResponse
+    include SubUr
 
     def addressable_uri
       uri ? Addressable::URI.parse(uri) : nil

data/lib/ur/request_and_response.rb

@@ -19,5 +19,21 @@ class Ur
       end
     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
+
+    def content_type
+      headers.each do |k, v|
+        return v if k =~ /\Acontent[-_]type\z/i
+      end
+      nil
+    end
+
+    def media_type
+      content_type_attrs.media_type
+    end
   end
 end

data/lib/ur/response.rb

@@ -3,5 +3,18 @@ require 'ur' unless Object.const_defined?(:Ur)
 class Ur
   class Response
     include RequestAndResponse
+    include SubUr
+
+    def success?
+      (200..299).include?(status)
+    end
+
+    def client_error?
+      (400..499).include?(status)
+    end
+
+    def server_error?
+      (500..599).include?(status)
+    end
   end
 end

data/lib/ur/sub_ur.rb

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

data/lib/ur/version.rb

@@ -1 +1 @@
-UR_VERSION = "0.0.1"
+UR_VERSION = "0.0.2"

data/ur.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "~> 0.0.2"
+  spec.add_dependency "jsi", "~> 0.0.3"
   spec.add_dependency "addressable", "~> 2.0"
   spec.add_development_dependency "rack"
   spec.add_development_dependency "rack-test"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ur
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2019-01-24 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.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -195,11 +195,15 @@ files:
 - README.md
 - Rakefile.rb
 - lib/ur.rb
+- lib/ur/content_type_attrs.rb
+- lib/ur/faraday.rb
+- lib/ur/faraday/yield_ur.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