shaf 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b68c64b495d1413c70562c4deb0796113c93c4e3c4e269899d31a93baaa7574
-  data.tar.gz: ee75b02c4006994eb0f1ea1da93114687d0a5ee5dd64d1dcf62d5dc647210301
+  metadata.gz: 21af40642344c3526a2b34df81fe891ce407ac8ef822e125938d8ecc415fcba0
+  data.tar.gz: 8be6b04b3a460979d6494fda33a5a88797b23d6c3266bb51e5505184b70707da
 SHA512:
-  metadata.gz: 0f84860a9c7442d473378ecbd2ca61325bf71f848af65f1e742e01888a37ecb52e0c8bca9e8938eb9b70d5d167501616ce46096cdcba1f87e31299aa47184100
-  data.tar.gz: 7ed67fe1fe15cc5300b658eb3e0cfb3c79325829eb2969308a0f31ef06d26bcb5365b8600f716c1e75b85c2fcabdee4b7e17f5b16c999c8fdf6d0d9cfbc1f597
+  metadata.gz: 505ab287d131637d261d3391eeb58517cfe9aa6160d1e51bfb619544299bfea360b90a63ffb1ad0d2c70edaf4da7ca64c84f4de3d624a001c07d2eb0fdb27c10
+  data.tar.gz: 8dc0a97ed2b062b8bbb85cbcdce50a624e42ca010c12638a998deb33d9e7d1438d18a04d58ac8cdb5339286f9744a2948f8c63e0f739636b61940c35b0b8f0db

data.tar.gz.sig

@@ -1,2 +1,3 @@
-
-)�ϲ�
+)��pK�iІ�����j��p#�nt��g�CY�]�
�Y�
+�����u*wS1�^�S�3�r��|�\�2��a�I2�����A��5�$���Ov����=�IG&`.����Ta^Up��X^F
+�Q��+���vC�+L��yi��*��vӥ���j��~i��b�zQuI���}���l��D�����~+����Z�MI��2�J%8�J9�*H��jlT�	5ʬ���uNs��GV8��v+R��dO��3�p�,��

data/lib/shaf/extensions.rb

@@ -1,3 +1,4 @@
+require 'shaf/extensions/log'
 require 'shaf/extensions/resource_uris'
 require 'shaf/extensions/controller_hooks'
 require 'shaf/extensions/current_user'
@@ -7,6 +8,7 @@ require 'shaf/extensions/symbolic_routes'
 module Shaf
   def self.extensions
     [
+      Log,
       ResourceUris,
       ControllerHooks,
       CurrentUser,

data/lib/shaf/extensions/log.rb

@@ -0,0 +1,19 @@
+require 'logger'
+
+module Shaf
+  module Log
+    def self.registered(app)
+      app.helpers Helpers
+    end
+
+    def log
+      $logger ||= Logger.new('/dev/nul')
+    end
+  end
+
+  module Helpers
+    def log
+      self.class.log
+    end
+  end
+end

data/lib/shaf/helpers/json_html.rb

@@ -2,8 +2,11 @@ module Shaf
   module JsonHtml
 
     def json2html(json)
-      o = JSON.parse(json)
-      "<pre><code>#{to_html(o)}</code></pre>"
+      as_html JSON.parse(json)
+    end
+
+    def as_html(obj)
+      "<pre><code>#{to_html(obj)}</code></pre>"
     end
 
     private

data/lib/shaf/helpers/payload.rb

@@ -66,7 +66,7 @@ module Shaf
       @profile = value
     end
 
-    def respond_with_collection(resource, status: 200, serializer: nil, **kwargs)
+    def respond_with_collection(resource, status: nil, serializer: nil, preload: [], **kwargs)
       respond_with(
         resource,
         status: status,
@@ -76,7 +76,8 @@ module Shaf
       )
     end
 
-    def respond_with(resource, status: 200, serializer: nil, collection: false, **kwargs)
+    def respond_with(resource, status: nil, serializer: nil, collection: false, preload: [], **kwargs)
+      status ||= resource.respond_to?(:http_status) ? resource.http_status : 200
       status(status)
 
       kwargs.merge!(
@@ -86,15 +87,16 @@ module Shaf
       )
 
       log.info "#{request.request_method} #{request.path_info} => #{status}"
-      payload = Responder.for(request, resource).call(self, resource, **kwargs)
+      payload = Responder.for(request, resource).call(self, resource, preload: preload, **kwargs)
       add_cache_headers(payload, kwargs)
+      payload
     rescue StandardError => err
       log.error "Failure: #{err.message}\n#{err.backtrace}"
       if status == 500
         content_type mime_type(:json)
         body JSON.generate(failure: err.message)
       else
-        respond_with(Errors::ServerError.new(err.message), status: 500)
+        respond_with(Errors::ServerError.new(err.message))
       end
     end
 

data/lib/shaf/responder/base.rb

@@ -1,17 +1,23 @@
 module Shaf
   module Responder
     class Response
-      attr_reader :content_type, :body, :resource, :serialized
+      attr_reader :content_type, :body, :serialized_hash, :resource
 
-      def initialize(content_type, body, resource, serialized = nil)
+      def initialize(content_type:, body:, serialized_hash: {}, resource: nil)
         @content_type = content_type
         @body = body
+        @serialized_hash = serialized_hash
         @resource = resource
-        @serialized = serialized
+      end
+
+      def log_entry
+        "Response (#{resource.class}) payload: #{body}"
       end
     end
 
     class Base
+      PRELOAD_FAILED_MSG = "Failed to preload '%s'. Link could not be extracted from response"
+
       class << self
         def mime_type(type = nil, value = nil)
           if type
@@ -29,11 +35,12 @@ module Shaf
           Responder.default = self
         end
 
-        def call(controller, resource, **kwargs)
+        def call(controller, resource, preload: [], **kwargs)
           responder = new(controller, resource, **kwargs)
-          response = responder.response
+          response = responder.build_response
           log_response(controller, response)
-          write_response(controller, response)
+          preload_links = preload_links(preload, responder, response, controller)
+          write_response(controller, response, preload_links)
         end
 
         def can_handle?(_obj)
@@ -43,17 +50,43 @@ module Shaf
         private
 
         def log_response(controller, response)
+          log(controller, response.log_entry)
+        end
+
+        def log(controller, msg, type: :debug)
           return unless controller.respond_to? :log
+          controller.log.send(type, msg)
+        end
 
-          controller.log.debug(
-            "Response (#{response.resource.class}) payload: #{response.serialized}"
-          )
+        def preload_links(rels, responder, response, controller = nil)
+          Array(rels).map do |rel|
+            links = responder.lookup_rel(rel, response)
+            links = [links].compact unless links.is_a? Array
+            log(controller, PRELOAD_FAILED_MSG % rel) if links.empty?
+            links
+          end
         end
 
-        def write_response(controller, response)
+        def write_response(controller, response, preload_links)
           controller.content_type(response.content_type)
+          add_preload_links(controller, response, preload_links)
           controller.body(response.body)
         end
+
+        def add_preload_links(controller, response, preload_links)
+          preload_links.each do |links|
+            links.each do |link|
+              next unless link[:href]
+              # Nginx http2_push_preload only processes relative URIs with absolute path
+              href = link[:href].sub(%r{https?://[^/]+}, "")
+              type = link.fetch(:as, 'fetch')
+              xorigin = link.fetch(:crossorigin, 'anonymous')
+              links = (controller.headers['Link'] || "").split(',').map(&:strip)
+              links << "<#{href}>; rel=preload; as=#{type}; crossorigin=#{xorigin}"
+              controller.headers["Link"] = links.join(', ') unless links.empty?
+            end
+          end
+        end
       end
 
       attr_reader :controller, :resource, :options
@@ -68,12 +101,21 @@ module Shaf
         raise NotImplementedError, "#{self.class} must implement #body"
       end
 
-      def serialized
-        @serialize
+      def serialized_hash
+        {}
       end
 
-      def response
-        Response.new(mime_type, body, resource, serialized)
+      def build_response
+        Response.new(
+          content_type: mime_type,
+          body: body,
+          serialized_hash: serialized_hash,
+          resource: resource
+        )
+      end
+
+      def lookup_rel(_rel, _response)
+        []
       end
 
       private
@@ -82,30 +124,11 @@ module Shaf
         self.class.mime_type
       end
 
-      def collection?
-        !!options.fetch(:collection, false)
-      end
-
       def user
         options.fetch(:current_user) do
           controller.current_user if controller.respond_to? :current_user
         end
       end
-
-      def serializer
-         @serializer ||= options[:serializer] || HALPresenter.lookup_presenter(resource)
-      end
-
-      def serialize
-        return "" unless serializer
-
-        @serialize ||=
-          if collection?
-            serializer.to_collection(resource, current_user: user, **options)
-          else
-            serializer.to_hal(resource, current_user: user, **options)
-          end
-      end
     end
   end
 end

data/lib/shaf/responder/hal.rb

@@ -1,11 +1,15 @@
+require 'shaf/responder/hal_serializable'
+
 module Shaf
   module Responder
     class Hal < Base
-      mime_type :hal, 'application/hal+json'
+      include HalSerializable
+
       use_as_default!
+      mime_type :hal, 'application/hal+json'
 
       def body
-        serialize
+        @body ||= JSON.generate(serialized_hash)
       end
 
       private

data/lib/shaf/responder/hal_serializable.rb

@@ -0,0 +1,54 @@
+require 'hal_presenter'
+require 'shaf/errors'
+
+module Shaf
+  module Responder
+    module HalSerializable
+      def lookup_rel(rel, response)
+        hal = response.serialized_hash
+        return [] unless hal
+
+        links = hal.dig(:_links, rel.to_sym)
+        return [] unless links
+
+        links = [links] unless links.is_a? Array
+        links.map do |link|
+          {
+            href: link[:href],
+            as: 'fetch',
+            crossorigin: 'anonymous'
+          }
+        end
+      end
+
+      def collection?
+        !!options.fetch(:collection, false)
+      end
+
+      def serializer
+        @serializer ||= options[:serializer] || HALPresenter.lookup_presenter(resource)
+      end
+
+      def serialized_hash
+        return {} unless serializer
+
+        @serialized_hash ||=
+          if collection?
+            serializer.to_collection(resource, current_user: user, as_hash: true, **options)
+          else
+            serializer.to_hal(resource, current_user: user, as_hash: true, **options)
+          end
+
+        # hal_presenter versions before v1.5.0 does not understand the :as_hash
+        # keyword argument and will always return a String from
+        # to_hal/to_collection, thus we need to parse it if its a String.
+        if @serialized_hash.is_a? String
+          @body = @serialized_hash
+          @serialized_hash = JSON.parse(@serialized_hash, symbolize_names: true)
+        end
+
+        @serialized_hash
+      end
+    end
+  end
+end

data/lib/shaf/responder/html.rb

@@ -1,14 +1,18 @@
+require 'shaf/responder/hal_serializable'
+
 module Shaf
   module Responder
     class Html < Base
+      include HalSerializable
+
       mime_type :html
 
       def body
         case resource
         when Formable::Form
-          controller.erb(:form, locals: {form: resource, serialized: serialize})
+          controller.erb(:form, locals: {form: resource, serialized: serialized_hash})
         else
-          controller.erb(:payload, locals: {serialized: serialize})
+          controller.erb(:payload, locals: {serialized: serialized_hash})
         end
       end
     end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/templates/api/controllers/base_controller.rb

@@ -19,19 +19,6 @@ class BaseController < Sinatra::Base
 
   Shaf::Router.mount(self, default: true)
 
-  def self.inherited(controller)
-    super
-    Shaf::Router.mount controller
-  end
-
-  def self.log
-    $logger
-  end
-
-  def log
-    self.class.log
-  end
-
   register(*Shaf.extensions)
   helpers(*Shaf.helpers)
 
@@ -42,13 +29,6 @@ class BaseController < Sinatra::Base
     set_vary_header
   end
 
-  def set_vary_header
-    return unless settings.auth_token_header
-    return unless [:get, :head].include? request.request_method.downcase.to_sym
-
-    headers('Vary' => Shaf::Settings.auth_token_header)
-  end
-
   not_found do
     err = NotFoundError.new "Resource \"#{request.path_info}\" does not exist"
     respond_with(err, status: err.http_status)
@@ -59,12 +39,22 @@ class BaseController < Sinatra::Base
     log.error err.message
     Array(err.backtrace).each(&log.method(:error))
 
-    api_error = to_api_error(err)
+    respond_with api_error(err)
+  end
 
-    respond_with(api_error, status: api_error.http_status)
+  def self.inherited(controller)
+    super
+    Shaf::Router.mount controller
+  end
+
+  def set_vary_header
+    return unless settings.auth_token_header
+    return unless [:get, :head].include? request.request_method.downcase.to_sym
+
+    headers('Vary' => Shaf::Settings.auth_token_header)
   end
 
-  def to_api_error(err)
+  def api_error(err)
     case err
     when Shaf::Authorize::PolicyViolationError
       ForbiddenError.new

data/templates/config/directories.rb

@@ -46,7 +46,6 @@ end
 %i[lib_dir src_dir app_dir].each do |cfg|
   dir = Shaf::Settings.send cfg
   next unless Dir.exist? dir
-  $LOAD_PATH.unshift dir
 
   Dir.chdir(dir) do
     require_ruby_files

data/templates/config/paths.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 app_root = File.expand_path('../', __dir__)
-Shaf::Settings.app_root = app_root
-Shaf::Settings.app_dir = File.expand_path('api', app_root)
-Shaf::Settings.src_dir = File.expand_path('src', app_root)
-Shaf::Settings.lib_dir = File.expand_path('lib', app_root)
-Shaf::Settings.spec_dir = File.expand_path('spec', app_root)
+[
+  Shaf::Settings.app_root = app_root,
+  Shaf::Settings.app_dir = File.expand_path('api', app_root),
+  Shaf::Settings.src_dir = File.expand_path('src', app_root),
+  Shaf::Settings.lib_dir = File.expand_path('lib', app_root),
+  Shaf::Settings.spec_dir = File.expand_path('spec', app_root)
+].each do |dir|
+  $LOAD_PATH.unshift(dir) if Dir.exist? dir
+end

data/templates/frontend/views/form.erb

@@ -10,7 +10,7 @@
   </section>
   <section class="section">
     <div class="hal-payload">
-      <%= json2html(serialized) %>
+      <%= as_html(serialized) %>
     </div>
   </section>
 </div>

data/templates/frontend/views/payload.erb

@@ -2,7 +2,7 @@
 <div class="container">
   <section class="section">
     <div class="hal-payload">
-      <%= json2html(serialized) %>
+      <%= as_html(serialized) %>
     </div>
   </section>
 </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-12-22 00:00:00.000000000 Z
+date: 2020-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: hal_presenter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: A framework for building hypermedia driven APIs with sinatra and sequel.
 email: sammy.henningsson@gmail.com
 executables:
@@ -208,6 +222,7 @@ files:
 - lib/shaf/extensions/authorize.rb
 - lib/shaf/extensions/controller_hooks.rb
 - lib/shaf/extensions/current_user.rb
+- lib/shaf/extensions/log.rb
 - lib/shaf/extensions/resource_uris.rb
 - lib/shaf/extensions/symbolic_routes.rb
 - lib/shaf/formable.rb
@@ -258,6 +273,7 @@ files:
 - lib/shaf/responder.rb
 - lib/shaf/responder/base.rb
 - lib/shaf/responder/hal.rb
+- lib/shaf/responder/hal_serializable.rb
 - lib/shaf/responder/html.rb
 - lib/shaf/responder/problem_json.rb
 - lib/shaf/router.rb
@@ -328,6 +344,7 @@ files:
 - upgrades/1.2.1.tar.gz
 - upgrades/1.3.0.tar.gz
 - upgrades/1.4.0.tar.gz
+- upgrades/1.5.0.tar.gz
 homepage: 
 licenses:
 - MIT

metadata.gz.sig

@@ -1 +1,2 @@
-ra��TNݚ�Fѫ����T$�>+"�>..��S�J�d�tJ0/�Ȝ&N�gޡ"���&T&���.�ph�b���?Y�W;.)����Ns`ҟ�б�43�6�������
�P��J��8�{��`��e9?��e�⹾GkFk9��S����(��D��1J��l"-��G*�����]
\���s4���L�����x����w�~�P5�G��Q����S��`
q�x��=C���ln�j�%�R3ߑ[a
+ZN��l�|��>�d�
+ne�H��t̊9��%����D