shaf_client 0.6.2 → 1.1.0

data/lib/shaf_client/resource_mapper.rb

@@ -1,18 +1,26 @@
 require 'shaf_client/error'
+require 'shaf_client/content_type_map'
+require 'shaf_client/resource_extension'
 
 class ShafClient
-  class ResourceMapper
+  module ResourceMapper
     class << self
-      def for(content_type)
-        mapping[content_type&.to_sym].tap do |clazz|
-          next if clazz
-          raise UnSupportedContentType,
-            "Can't handle Content-Type: #{content_type}"
-        end
+      def for(content_type:, headers: {}, payload: nil, client: nil)
+        content_type = content_type&.to_sym
+        profile = profile_from(content_type, headers, payload)
+        clazz, extensions = result_for(content_type, payload, profile, client)
+
+        raise_unsupported_error(content_type) unless clazz
+
+        [clazz, extensions]
+      end
+
+      def register(content_type, profile = nil, clazz)
+        mapping[content_type&.to_sym, profile] = clazz
       end
 
-      def register(content_type, clazz)
-        mapping[content_type&.to_sym] = clazz
+      def unregister(content_type, profile = nil)
+        mapping.delete(content_type.to_sym, profile)
       end
 
       def default=(clazz)
@@ -22,7 +30,75 @@ class ShafClient
       private
 
       def mapping
-        @mapping ||= {}
+        @mapping ||= ContentTypeMap.new
+      end
+
+      def result_for(content_type, payload, profile, client)
+        clazz = nil
+        extensions = []
+
+        # Note: mapping typically has a default value, so we need to check that the key really exist
+        if mapping.key? content_type, profile
+          # Registered classes with profile takes precedence over linked profiles
+          clazz = mapping[content_type, profile]
+        else
+          clazz = mapping[content_type]
+          extensions = extensions_for(clazz, profile, payload, client) if profile
+        end
+
+        [clazz, extensions]
+      end
+
+      def profile_from(content_type, headers, payload)
+        profile_from_content_type(content_type) ||
+          profile_from_link_header(headers) ||
+          profile_from_payload_link(content_type, payload)
+      rescue StandardError => err
+        warn "Exception while looking up profile link relation: #{err}"
+      end
+
+      def profile_from_content_type(content_type)
+        return unless content_type
+
+        content_type[/profile="?([^"\s;]*)/, 1]
+      end
+
+      def profile_from_link_header(headers)
+        links = String(headers["link"] || headers["Link"]).split(',')
+        profile_link = links.find { |link| link.match?(/rel="?profile"?/) }
+        profile_link[/<(.*)>/, 1] if profile_link
+      end
+
+      def profile_from_payload_link(content_type, payload)
+        clazz = mapping[content_type]
+        resource = clazz&.new(nil, payload)
+        return unless resource.respond_to? :link
+
+        link = resource.link(:profile) { nil }
+        link&.href
+      end
+
+      def extensions_for(clazz, profile, payload, client)
+        return [] unless clazz && profile && client
+
+        profile_resource = fetch_profile(profile, client)
+        link_relations = clazz.new(nil, payload).actions if payload
+
+        ResourceExtension.for(profile_resource, clazz, link_relations, client)
+      rescue StandardError => err
+        warn "Exception while resolving extensions for profile " \
+          "#{profile_resource&.name || profile}: #{err}"
+        []
+      end
+
+      def fetch_profile(profile, client)
+        return unless profile&.start_with? %r{https?://}
+
+        client.get(profile)
+      end
+
+      def raise_unsupported_error(content_type)
+        raise UnSupportedContentType, "Can't handle Content-Type: #{content_type}"
       end
     end
   end

data/lib/shaf_client/shaf_form.rb

@@ -3,7 +3,8 @@ require 'shaf_client/form'
 class ShafClient
   class ShafForm < Form
 
-    profile 'shaf-form'
+    profile 'shaf-form' #  Legacy profiles
+    profile 'urn:shaf:form' # New style. Shaf version >= 2.1.0
 
     def title
       attribute(:title)
@@ -27,7 +28,7 @@ class ShafClient
 
     def fields
       attribute(:fields).map do |values|
-        Field.new(values.transform_keys(&:to_sym))
+        Field.new(**values.transform_keys(&:to_sym))
       end
     end
   end

data/lib/shaf_client/status_codes.rb

@@ -0,0 +1,70 @@
+class ShafClient
+  module StatusCodes
+    StatusCode = {
+      100 => 'Continue',
+      101 => 'Switching Protocols',
+      102 => 'Processing',
+      103 => 'Early Hints',
+      200 => 'OK',
+      201 => 'Created',
+      202 => 'Accepted',
+      203 => 'Non-Authoritative Information',
+      204 => 'No Content',
+      205 => 'Reset Content',
+      206 => 'Partial Content',
+      207 => 'Multi-Status',
+      208 => 'Already Reported',
+      226 => 'IM Used',
+      300 => 'Multiple Choices',
+      301 => 'Moved Permanently',
+      302 => 'Found',
+      303 => 'See Other',
+      304 => 'Not Modified',
+      305 => 'Use Proxy',
+      306 => '(Unused)',
+      307 => 'Temporary Redirect',
+      308 => 'Permanent Redirect',
+      400 => 'Bad Request',
+      401 => 'Unauthorized',
+      402 => 'Payment Required',
+      403 => 'Forbidden',
+      404 => 'Not Found',
+      405 => 'Method Not Allowed',
+      406 => 'Not Acceptable',
+      407 => 'Proxy Authentication Required',
+      408 => 'Request Timeout',
+      409 => 'Conflict',
+      410 => 'Gone',
+      411 => 'Length Required',
+      412 => 'Precondition Failed',
+      413 => 'Payload Too Large',
+      414 => 'URI Too Long',
+      415 => 'Unsupported Media Type',
+      416 => 'Range Not Satisfiable',
+      417 => 'Expectation Failed',
+      421 => 'Misdirected Request',
+      422 => 'Unprocessable Entity',
+      423 => 'Locked',
+      424 => 'Failed Dependency',
+      425 => 'Too Early',
+      426 => 'Upgrade Required',
+      428 => 'Precondition Required',
+      429 => 'Too Many Requests',
+      431 => 'Request Header Fields Too Large',
+      451 => 'Unavailable For Legal Reasons',
+      500 => 'Internal Server Error',
+      501 => 'Not Implemented',
+      502 => 'Bad Gateway',
+      503 => 'Service Unavailable',
+      504 => 'Gateway Timeout',
+      505 => 'HTTP Version Not Supported',
+      506 => 'Variant Also Negotiates',
+      507 => 'Insufficient Storage',
+      508 => 'Loop Detected',
+      510 => 'Not Extended',
+      511 => 'Network Authentication Required',
+    }
+    StatusCode.default = 'Unassigned'
+    StatusCode.freeze
+  end
+end

data/lib/shaf_client/test/stubbing.rb

@@ -0,0 +1,16 @@
+class ShafClient
+  module Test
+    module Stubbing
+      def stubs
+        return unless @adapter == :test
+        @stubs ||= Faraday::Adapter::Test::Stubs.new
+      end
+
+      def adapter_args
+        args = super
+        args << stubs if @adapter == :test
+        args 
+      end
+    end
+  end
+end

data/lib/shaf_client/unknown_resource.rb

@@ -2,9 +2,9 @@ require 'shaf_client/resource'
 
 class ShafClient
   class UnknownResource < Resource
-    attr_reader :http_status, :headers, :body
+    default_resource_class!
 
-    ResourceMapper.default = self
+    attr_reader :http_status, :headers, :body
 
     def initialize(_client, payload, status = nil, headers = {})
       @body = payload.freeze
@@ -22,7 +22,7 @@ class ShafClient
 
     %i[get put post delete patch, get_doc, reload!].each do |method|
       define_method(method) do |*_args|
-        raise "UnknownResource: #{method} not available"
+        raise Error, "UnknownResource: #{method} not available"
       end
     end
   end

data/lib/shaf_client/version.rb

@@ -0,0 +1,3 @@
+class ShafClient
+  VERSION = "1.1.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf_client
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -10,27 +10,26 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDXjCCAkagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFzYW1t
-  eS5oZW5uaW5nc3Nvbi9EQz1nbWFpbC9EQz1jb20wHhcNMTgwNzE2MTYzNTMzWhcN
-  MjAwNzE2MTYzNTMzWjAsMSowKAYDVQQDDCFzYW1teS5oZW5uaW5nc3Nvbi9EQz1n
-  bWFpbC9EQz1jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvkgwt
-  Zn8obnCelWttayB1BrHBLUK3b8gasRRtbNk4DzAL+EW6sHSVT2u5I7Wws7JQA5VB
-  NaK7tgvq3CbDLVRl9NrpDCDx09To08stPxDKi6kst1nkSPAD8g0sQlW3voeQTH98
-  2Z2H3XUegHhu5Z9PU9T/7V/vZUzHPiPg1tX1JUIGOPAjVGsr7SUetbL171zK4S4Y
-  tvUkIoNaph+maHttvyYB/ptiZLD53WORKd4Knw3OiJsLtrxr5hhKyQ+txQdF0P8G
-  +FlR+Je7B0Ek3yg6fEiJgrdcajYCMo8Oe/GRtoHhi6J3LsYA620P1BSCddZQ2XeL
-  y3rzIZyMU0iaT69nAgMBAAGjgYowgYcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
-  HQYDVR0OBBYEFLpI49QndnmuiDhwy2XtMps7No1pMCYGA1UdEQQfMB2BG3NhbW15
-  Lmhlbm5pbmdzc29uQGdtYWlsLmNvbTAmBgNVHRIEHzAdgRtzYW1teS5oZW5uaW5n
-  c3NvbkBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQADggEBAFJZqH6sgeiTLvMLpxaK
-  K1GaYSCyZbMutf5C3tIAgkmU5UD6B8R0bw6gTM1deM5NJ60LjzqY7rlK3YKDIbTn
-  iXMCe9vd4yE/jb5Zi8Wk//9n8CMG68dQpBvmcQ58/M4gTtgsx+lIgXuI5dPQMmRi
-  bhWQqqWqxT9X6njjfXFk4xn3z6mfFQNPAYqRVeTHUpXBQZPt+bYXRwHPFZGWkx4l
-  BnuuhYKt3CR7YIgvnsQWlTAcU1Ipdayj6UfYqUtlc6cF3CL96NOx7mgZXV8URFiX
-  ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
-  M40=
+  MIIDVjCCAj6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9zYW1t
+  eS5oZW5uaW5nc3Nvbi9EQz1oZXkvREM9Y29tMB4XDTIxMDIwMjEzNTY1OFoXDTIy
+  MDIwMjEzNTY1OFowKjEoMCYGA1UEAwwfc2FtbXkuaGVubmluZ3Nzb24vREM9aGV5
+  L0RDPWNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK+SDC1mfyhu
+  cJ6Va21rIHUGscEtQrdvyBqxFG1s2TgPMAv4RbqwdJVPa7kjtbCzslADlUE1oru2
+  C+rcJsMtVGX02ukMIPHT1OjTyy0/EMqLqSy3WeRI8APyDSxCVbe+h5BMf3zZnYfd
+  dR6AeG7ln09T1P/tX+9lTMc+I+DW1fUlQgY48CNUayvtJR61svXvXMrhLhi29SQi
+  g1qmH6Zoe22/JgH+m2JksPndY5Ep3gqfDc6Imwu2vGvmGErJD63FB0XQ/wb4WVH4
+  l7sHQSTfKDp8SImCt1xqNgIyjw578ZG2geGLoncuxgDrbQ/UFIJ11lDZd4vLevMh
+  nIxTSJpPr2cCAwEAAaOBhjCBgzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQUukjj1Cd2ea6IOHDLZe0ymzs2jWkwJAYDVR0RBB0wG4EZc2FtbXkuaGVu
+  bmluZ3Nzb25AaGV5LmNvbTAkBgNVHRIEHTAbgRlzYW1teS5oZW5uaW5nc3NvbkBo
+  ZXkuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQBt310FZ56E/fp/y5Wym1xb4C0owfnI
+  LzUqOjXWZTO7RezlBJV/qIwqt6bEjYDQR56zULJFSp4YdoDsratmQ+/kwtbHF7xf
+  WYkSE36mhLP2ggQFH9fXtX6XdyIlwFqwEfNW73ZrkBXGjMxLVKIS9uHdN7PoNhbS
+  0YjOZZD/rq1Jf+klwl/G7bBDPjn58DWlUmwzoj49goGS/UBG37RssQxRwPelKHZh
+  5ZlcHq9h5CxVt380OKaU6wMg95RJBd/kUJqmPxxlxMH8QDQinTwZmmFA9wW7PJdy
+  wAx8px9LkSjTs0GVLH7VtVRWAELllsswCJktz63Adelx9fmIMgrTYgZM
   -----END CERTIFICATE-----
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +65,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +82,7 @@ dependencies:
         version: '5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: 5.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -93,28 +92,58 @@ dependencies:
         version: '5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: 5.14.3
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: A HAL client customized for Shaf APIs
 email: sammy.henningsson@gmail.com
-executables: []
+executables:
+- shaf_client
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/shaf_client
+- lib/faraday_http_cache_patch.rb
 - lib/shaf_client.rb
+- lib/shaf_client/alps/descriptor.rb
+- lib/shaf_client/alps/extension.rb
+- lib/shaf_client/alps_json.rb
 - lib/shaf_client/api_error.rb
 - lib/shaf_client/base_resource.rb
+- lib/shaf_client/content_type_map.rb
 - lib/shaf_client/curie.rb
 - lib/shaf_client/empty_resource.rb
 - lib/shaf_client/error.rb
 - lib/shaf_client/field.rb
 - lib/shaf_client/form.rb
 - lib/shaf_client/hal_form.rb
+- lib/shaf_client/hypertext_cache_strategy.rb
 - lib/shaf_client/link.rb
 - lib/shaf_client/middleware/redirect.rb
+- lib/shaf_client/mime_types.rb
+- lib/shaf_client/problem_json.rb
 - lib/shaf_client/resource.rb
+- lib/shaf_client/resource_extension.rb
+- lib/shaf_client/resource_extension/alps_http_method.rb
+- lib/shaf_client/resource_extension/base.rb
 - lib/shaf_client/resource_mapper.rb
 - lib/shaf_client/shaf_form.rb
+- lib/shaf_client/status_codes.rb
+- lib/shaf_client/test/stubbing.rb
 - lib/shaf_client/unknown_resource.rb
+- lib/shaf_client/version.rb
 homepage: https://github.com/sammyhenningsson/shaf_client
 licenses:
 - MIT
@@ -134,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: HAL client for Shaf