shaf_client 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d368622457d097eda4375008f44dabd5f2757e860e777347fee28679eb517a3
-  data.tar.gz: 4f59085a13b589b01f3e4dec49c08410f3bc7617e54fa64f8d16fab260bb3a22
+  metadata.gz: de51f879d8fd9a032434411bbe29df1b1dd6629c39277c1373384ae10615e2ff
+  data.tar.gz: fa37f60def169a85f3910d6c4dd36faa3155b299f42725606682500e722c504e
 SHA512:
-  metadata.gz: e9e353931db9365e43038a6bfbf89ec19a1bd5e1e96031821517e582261c730e7c2e4c860ee3e937951c042c454f5176e627d3b3fd3b3126bd7c696361aa5ee8
-  data.tar.gz: 7f23e71a7ccab43837f152ed5285118f1cbbff0aafdf439d18a58fba44ef736ceb00d260b3b4612638c5dc54b1338eedec3bece80c88a05ac5b7bd9d29f779e2
+  metadata.gz: 6e11dd7e17aa9052606440cbb16c06e8bec99933b0d1033c803116e14c18591795eb26304277288f249c8812a3991d8a2a3bca6deedd1e0c59ea0a1a529abd85
+  data.tar.gz: 4db2d441198e463dc8f590638d2017baab472d4d00a205b0694c6b9aef74f6952d5fb715e408f81da70959bbf9d7aeb02970ecc78a1853859dbcb595c0c43432

data/lib/shaf_client/base_resource.rb

@@ -10,8 +10,13 @@ class ShafClient
       @payload =
         if payload&.is_a? String
           JSON.parse(payload)
+        elsif payload.respond_to? :to_h
+          payload.to_h
         else
-          payload
+          raise Error, <<~ERR
+            Trying to create an instance of #{self.class} with a payload that
+            cannot be coerced into a Hash
+          ERR
         end
 
       parse
@@ -19,8 +24,9 @@ class ShafClient
 
     def to_h
       attributes.dup.tap do |hash|
-        hash[:_links] = transform_values_to_s(links)
-        embedded = transform_values_to_s(embedded_resources)
+        hash[:_links] = transform_values_to_h(links)
+        hash[:_links].merge!(curies: curies.values.map(&:to_h)) unless curies.empty?
+        embedded = transform_values_to_h(embedded_resources)
         hash[:_embedded] = embedded unless embedded.empty?
       end
     end
@@ -34,31 +40,23 @@ class ShafClient
     end
 
     def attribute(key)
-      raise Error, "No attribute for key: #{key}" unless attributes.key? key
-      attributes.fetch(key.to_sym)
+      _attribute(key) or raise Error, "No attribute for key: #{key}"
     end
 
     def link(rel)
-      rewritten_rel = best_match(links.keys, rel)
-      raise Error, "No link with rel: #{rel}" unless links.key? rewritten_rel
-      links[rewritten_rel]
+      _link(rel) or raise Error, "No link with rel: #{rel}"
     end
 
     def curie(rel)
-      raise Error, "No curie with rel: #{rel}" unless curies.key? rel.to_sym
-      curies[rel.to_sym]
+      _curie(rel) or raise Error, "No curie with rel: #{rel}"
     end
 
     def embedded(rel)
-      rewritten_rel = best_match(embedded_resources.keys, rel)
-      unless embedded_resources.key? rewritten_rel
-        raise Error, "No embedded resources with rel: #{rel}"
-      end
-      embedded_resources[rewritten_rel]
+      _embedded(rel) or raise Error, "No embedded resources with rel: #{rel}"
     end
 
     def rel?(rel)
-      !link(rel).nil?
+      !link(rel).nil? || !embedded(rel).nil?
     rescue StandardError
       false
     end
@@ -77,6 +75,24 @@ class ShafClient
       @payload ||= {}
     end
 
+    def _attribute(key)
+      attributes[key.to_sym]
+    end
+
+    def _link(rel)
+      rewritten_rel = best_match(links.keys, rel)
+      links[rewritten_rel]
+    end
+
+    def _curie(rel)
+      curies[rel.to_sym]
+    end
+
+    def _embedded(rel)
+      rewritten_rel = best_match(embedded_resources.keys, rel)
+      embedded_resources[rewritten_rel]
+    end
+
     def <<(other)
       @payload            = other.payload.dup
       @attributes         = other.attributes.dup
@@ -148,7 +164,7 @@ class ShafClient
       best_match(rels, rel.to_s.tr('_', '-')) if rel.to_s.include? '_'
     end
 
-    def transform_values_to_s(hash)
+    def transform_values_to_h(hash)
       hash.transform_values do |value|
         if value.is_a? Array
           value.map(&:to_h)

data/lib/shaf_client/curie.rb

@@ -26,5 +26,9 @@ class ShafClient
       args[:rel] &&= args[:rel].to_s.sub(/#{name}:/, '')
       super(**args)
     end
+
+    def to_h
+      {name: name}.merge(super)
+    end
   end
 end

data/lib/shaf_client/empty_resource.rb

@@ -21,7 +21,7 @@ class ShafClient
 
     %i[get put post delete patch, get_doc, reload!].each do |method|
       define_method(method) do |*_args|
-        raise "EmptyResource: #{method} not available"
+        raise Error, "EmptyResource: #{method} not available"
       end
     end
   end

data/lib/shaf_client/hypertext_cache_strategy.rb

@@ -0,0 +1,47 @@
+class ShafClient
+  module HypertextCacheStrategy
+    AVAILABLE_CACHE_STRATEGIES = [
+      CACHE_STRATEGY_NO_CACHE = :no_cache,
+      CACHE_STRATEGY_EMBEDDED = :use_embedded,
+      CACHE_STRATEGY_FETCH_HEADERS = :fetch_headers
+    ]
+
+    class << self
+      def cacheable?(strategy)
+        [CACHE_STRATEGY_EMBEDDED, CACHE_STRATEGY_FETCH_HEADERS].include? strategy
+      end
+
+      def fetch_headers?(strategy)
+        CACHE_STRATEGY_FETCH_HEADERS == strategy
+      end
+
+      def default_http_status
+        203
+      end
+
+      def default_headers
+        {'content-type' => 'application/hal+json'}
+      end
+    end
+
+    def default_hypertext_cache_strategy
+      @__default_hypertext_cache_strategy ||= CACHE_STRATEGY_EMBEDDED
+    end
+
+    def default_hypertext_cache_strategy=(strategy)
+      unless __valid_cache? strategy
+        raise Error, <<~ERR
+          Unsupported hypertext cache strategy: #{strategy}
+          Possible strategies are: #{AVAILABLE_CACHE_STRATEGIES.join(', ')}
+        ERR
+      end
+      @__default_hypertext_cache_strategy = value
+    end
+
+    private
+
+    def __valid_cache?(strategy)
+      AVAILABLE_CACHE_STRATEGIES.include? strategy
+    end
+  end
+end

data/lib/shaf_client/mime_types.rb

@@ -0,0 +1,7 @@
+class ShafClient
+  module MimeTypes
+    MIME_TYPE_JSON = 'application/json'
+    MIME_TYPE_HAL  = 'application/hal+json'
+    DEFAULT_ADAPTER = :net_http
+  end
+end

data/lib/shaf_client/resource.rb

@@ -4,21 +4,23 @@ require 'shaf_client/base_resource'
 
 class ShafClient
   class Resource < BaseResource
+    include MimeTypes
+
     attr_reader :http_status, :headers
 
-    ResourceMapper.register("application/hal+json", self)
+    ResourceMapper.register(MIME_TYPE_HAL, self)
 
     def self.content_type(type)
       ResourceMapper.register(type, self)
     end
 
     def self.profile(name)
-      content_type "application/hal+json;profile=#{name}"
+      content_type "#{MIME_TYPE_HAL};profile=#{name}"
     end
 
-    def self.build(client, payload, status = nil, headers = {})
-      content_type = headers.fetch('content-type', '')
-      ResourceMapper.for(content_type).new(client, payload, status, headers)
+    def self.build(client, payload, content_type = MIME_TYPE_HAL, status = nil, headers = {})
+      ResourceMapper.for(content_type)
+        .new(client, payload, status, headers)
     end
 
     def initialize(client, payload, status = nil, headers = {})
@@ -36,14 +38,21 @@ class ShafClient
       RESOURCE
     end
 
-    %i[get put post delete patch].each do |method|
+    %i[put post delete patch].each do |method|
       define_method(method) do |rel, payload = nil, **options|
         href = link(rel).href
         client.send(method, href, payload: payload, **options)
       end
     end
 
-    def get_doc(rel)
+    def get(rel, **options)
+      href = link(rel).href
+      embedded_resource = _embedded(rel)
+      cached_resource = hypertext_cache_resource(href, embedded_resource, options)
+      cached_resource || client.get(href, **options)
+    end
+
+    def get_doc(rel, **options)
       rel = rel.to_s
       curie_name, rel =
         if rel.include? ':'
@@ -54,7 +63,7 @@ class ShafClient
 
       curie = curie(curie_name)
       uri = curie.resolve_templated(rel: rel)
-      client.get_doc(uri)
+      client.get(uri, options)
     end
 
     def get_hal_form(rel)
@@ -91,5 +100,34 @@ class ShafClient
     private
 
     attr_reader :client
+
+    def hypertext_cache_strategy(options)
+      options.fetch(:hypertext_cache_strategy) do
+        ShafClient.default_hypertext_cache_strategy
+      end
+    end
+
+    def hypertext_cache?(options)
+      HypertextCacheStrategy.cacheable? hypertext_cache_strategy(options)
+    end
+
+    def hypertext_cache_resource(href, embedded_resource, options)
+      return unless embedded_resource
+
+      cache_strategy = hypertext_cache_strategy(options)
+      return unless HypertextCacheStrategy.cacheable? cache_strategy
+
+      if HypertextCacheStrategy.fetch_headers? cache_strategy
+        resource = client.head(href, options)
+        status = resource.http_status
+        headers = resource.headers
+        embedded_resource = embedded_resource.payload
+      else
+        status = HypertextCacheStrategy.default_http_status
+        headers = HypertextCacheStrategy.default_headers
+      end
+
+      self.class.build(client, embedded_resource, headers['content-type'], status, headers)
+    end
   end
 end

data/lib/shaf_client/resource_mapper.rb

@@ -15,6 +15,10 @@ class ShafClient
         mapping[content_type&.to_sym] = clazz
       end
 
+      def unregister(content_type)
+        mapping.delete(content_type.to_sym)
+      end
+
       def default=(clazz)
         mapping.default = clazz
       end

data/lib/shaf_client/unknown_resource.rb

@@ -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 = "0.7.0"
+end

data/lib/shaf_client.rb

@@ -9,6 +9,7 @@ require 'faraday_http_cache_patch'
 
 require 'json'
 require 'shaf_client/error'
+require 'shaf_client/mime_types'
 require 'shaf_client/middleware/redirect'
 require 'shaf_client/resource'
 require 'shaf_client/shaf_form'
@@ -16,10 +17,12 @@ require 'shaf_client/hal_form'
 require 'shaf_client/api_error'
 require 'shaf_client/empty_resource'
 require 'shaf_client/unknown_resource'
+require 'shaf_client/hypertext_cache_strategy'
 
 class ShafClient
-  MIME_TYPE_JSON = 'application/json'
-  MIME_TYPE_HAL  = 'application/hal+json'
+  extend HypertextCacheStrategy
+  include MimeTypes
+
   DEFAULT_ADAPTER = :net_http
 
   def initialize(root_uri, **options)
@@ -35,12 +38,7 @@ class ShafClient
     get(@root_uri, **options)
   end
 
-  def get_doc(uri, **options)
-    response = request(method: :get, uri: uri, opts: options)
-    response&.body || ''
-  end
-
-  %i[get put post delete patch].each do |method|
+  %i[head get put post delete patch].each do |method|
     define_method(method) do |uri, payload: nil, **options|
       response = request(
         method: method,
@@ -50,9 +48,9 @@ class ShafClient
       )
 
       body = String(response.body)
-      response.headers['content-type'] = nil if body.empty?
+      content_type = response.headers['content-type'] unless body.empty?
 
-      Resource.build(self, body, response.status, response.headers)
+      Resource.build(self, body, content_type, response.status, response.headers)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf_client
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -110,12 +110,15 @@ files:
 - 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/resource.rb
 - lib/shaf_client/resource_mapper.rb
 - lib/shaf_client/shaf_form.rb
 - lib/shaf_client/unknown_resource.rb
+- lib/shaf_client/version.rb
 homepage: https://github.com/sammyhenningsson/shaf_client
 licenses:
 - MIT

metadata.gz.sig

@@ -1,2 +1,2 @@
-p�b�WQ�l%�f����;b�YjÛys��C��bC)(�rjlP:�����l�OP�����5�J��� � �mzU3�-"��䤌�ӂ�Ex#����h;aU�tK����Z�=�;�gq�ݑ��$�ܧ|�CYv� ��>I�"��/���5E�A����d[��ML^t�J������h1l�2���,‡���nȐ*��
-v��O���3�����}Y|&Y�5Hk��*�֭ %$U���}5�iKe�6��
+
��^���!�j��k\�
+,�P������\?�z��[+�mbsE�\Y�Ԧ�&��7�M?��ZXv����u����C�H�]*܋�i��v��l��f�o�a	G�_V�0/(��=!w����ht-3`�N