shaf 1.5.0 → 2.0.0

data/lib/shaf/generator/templates/api/policy.rb.erb

@@ -8,9 +8,9 @@ class <%= policy_class_name %> < BasePolicy
 
   <%= attributes.join("\n  ") %>
 
-  link :collection
+  link :collection, :up, :proflie
 
-  link :'create-form', :'edit-form', :delete do
+  link :create_form, :edit_form, :delete do
     write?
   end
 

data/lib/shaf/generator/templates/api/profile.rb.erb

@@ -0,0 +1,16 @@
+module Profiles
+  class <%= profile_class_name %> < Shaf::Profile
+    name '<%= profile_name %>'
+
+    doc 'FIXME: replace this with a description of the <%= profile_name %> profile'
+
+    use :delete, from: Shaf::Profiles::ShafBasic
+
+  <% attributes.each do |name, type| %>
+    attribute :<%= name %>,
+              type: '<%= type %>',
+              doc: 'FIXME: Write documentation for <%= name %>'
+
+  <% end %>
+  end
+end

data/lib/shaf/generator/templates/api/serializer.rb.erb

@@ -6,9 +6,9 @@ class <%= class_name %> < BaseSerializer
   model <%= model_class_name %>
   policy <%= policy_class_name %>
 
-  <%= print_nested(attributes_with_doc) %>
+  <%= print(profile_with_doc) %>
 
-  <%= print_nested(curies_with_doc) %>
+  <%= print_nested(attributes_with_doc) %>
 
   <%= print_nested(links_with_doc) %>
 

data/lib/shaf/generator/templates/spec/integration_spec.rb.erb

@@ -14,8 +14,7 @@ describe <%= model_class_name %>, type: :integration do
   end
 
   it "lists all <%= plural_name %>" do
-    <%= model_class_name %>.create
-    <%= model_class_name %>.create
+    2.times { <%= model_class_name %>.create }
 
     get <%= plural_name %>_uri
     _(status).must_equal 200

data/lib/shaf/generator/templates/spec/serializer_spec.rb.erb

@@ -15,8 +15,8 @@ describe <%= class_name %> do
     end
 
     it "serializes attributes" do
-<% attributes.each do |attr| -%>
-      _(attributes.keys).must_include(<%= attr %>)
+<% attribute_names.each do |attr| -%>
+      _(attributes.keys).must_include(:<%= attr %>)
 <% end -%>
     end
 
@@ -33,13 +33,13 @@ describe <%= class_name %> do
     end
 
     it "serializes attributes" do
-<% attributes.each do |attr| -%>
-      _(attributes.keys).must_include(<%= attr %>)
+<% attribute_names.each do |attr| -%>
+      _(attributes.keys).must_include(:<%= attr %>)
 <% end -%>
     end
 
     it "serializes links" do
-<% links.each do |rel| -%>
+<% link_relations.each do |rel| -%>
       _(link_rels).must_include(:'<%= rel %>')
 <% end -%>
     end

data/lib/shaf/helpers.rb

@@ -3,6 +3,8 @@ require 'shaf/helpers/json_html'
 require 'shaf/helpers/paginate'
 require 'shaf/helpers/payload'
 require 'shaf/helpers/http_header'
+require 'shaf/helpers/authentication'
+require 'shaf/helpers/vary'
 
 module Shaf
   def self.helpers
@@ -12,6 +14,8 @@ module Shaf
       Paginate,
       Payload,
       HttpHeader,
+      Authentication,
+      Vary,
     ]
   end
 end

data/lib/shaf/helpers/authentication.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'shaf/authenticator'
+require 'shaf/errors'
+
+module Shaf
+  module Authentication
+    class NoChallengesError < Error
+      def initialize(realm)
+        super("No Authentication challenges for realm: #{realm.inspect}")
+      end
+    end
+
+    class RealmChangedError < Error
+      def initialize(from:, to:)
+        super <<~ERR
+          Realm was changed from "#{from}" to "#{to}". This is not allowed!
+          Each request corresponds to a certain realm and cannot be changed.
+          This is probably caused by a call to `current_user` using the
+          default realm (from `Shaf::Settings.default_authentication_realm`)
+          and then using `#authenticate realm: 'some_other_realm'
+        ERR
+      end
+    end
+
+    def www_authenticate(realm: Settings.default_authentication_realm)
+      challenges = Authenticator.challenges_for(realm: realm)
+      raise NoChallengesError.new(realm) if challenges.empty?
+
+      headers 'WWW-Authenticate' => challenges.map(&:to_s)
+    end
+
+    def authenticate(realm: Settings.default_authentication_realm)
+      if defined?(@current_realm) && @current_realm&.to_s != realm&.to_s
+        raise RealmChangedError.new(from: @current_realm , to: realm)
+      else
+        @current_realm = realm
+      end
+
+      current_user.tap do |user|
+        www_authenticate(realm: realm) unless user
+      end
+    end
+
+    def authenticate!(realm: Settings.default_authentication_realm)
+      user = authenticate(realm: realm)
+      return user if user
+
+      msg = +"Unauthorized action"
+      msg << " (Realm: #{realm})" if realm
+      raise Shaf::Errors::UnauthorizedError, msg
+    end
+    alias current_user! authenticate!
+
+    def authenticated?
+      !current_user.nil?
+    end
+
+    def current_user
+      unless defined? @current_realm
+        if Settings.key? :default_authentication_realm
+          @current_realm = Settings.default_authentication_realm
+        else
+          Shaf.logger.info <<~MSG
+            No realm has been provided!
+            Authentication/authorization cannot be performed. Did you perhaps
+            forget to configure a realm in
+            `Settings.default_authentication_realm` or provide it when calling
+            `#authenticate!` (or `#authenticate!`)
+          MSG
+          return
+        end
+      end
+
+      @current_user ||= Authenticator.user(request.env, realm: @current_realm)
+    end
+  end
+end

data/lib/shaf/helpers/cache_control.rb

@@ -1,7 +1,6 @@
 module Shaf
   module CacheControl
     def cache_control(*args, **kwargs)
-      return unless Shaf::Settings.http_cache
       __rewrite_max_age(kwargs)
       super(*args, **kwargs)
     end
@@ -11,7 +10,7 @@ module Shaf
     def __rewrite_max_age(kwargs)
       max_age = kwargs.delete(:http_cache_max_age)
       if max_age.is_a? Symbol
-        key = "http_cache_max_age_#{max_age}".to_sym
+        key = :"http_cache_max_age_#{max_age}"
         max_age = Settings.respond_to?(key) ? Settings.send(key) : 86_400
       end
       kwargs[:max_age] ||= max_age

data/lib/shaf/helpers/json_html.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Shaf
   module JsonHtml
+    STRUCTURAL_PATTERN = /^[\[\]\{\}:,]$/.freeze
 
     def json2html(json)
       as_html JSON.parse(json)
@@ -18,7 +21,7 @@ module Shaf
       when Hash
         html_hash(obj, indent, pre_indent)
       else
-        html_scalar(obj, indent, pre_indent)
+        html_scalar(obj, pre_indent)
       end
     end
 
@@ -28,41 +31,78 @@ module Shaf
       end
 
       <<~EOS.chomp
-        #{pre_indent}<span>[</span>
-        #{array_of_strings.join(",\n")}
-        #{indentation(indent)}<span>]</span>
+        #{pre_indent}#{span '['}
+        #{array_of_strings.join(item_separator)}
+        #{indentation(indent)}#{span ']'}
       EOS
     end
 
     def html_hash(h, indent, pre_indent)
       <<~EOS.chomp
-        #{pre_indent}<span>{</span>
-        #{h.map { |k,v| sub_hash(k,v, indent + 1) }.join(",\n")},
-        #{indentation(indent)}<span>}</span>
+        #{pre_indent}#{span '{'}
+        #{h.map { |k,v| sub_hash(k,v, indent + 1) }.join(item_separator)}#{item_separator}
+        #{indentation(indent)}#{span '}'}
       EOS
     end
 
-    def html_scalar(s, indent, pre_indent)
-      q = around(s)
-      format "%s%s%s%s", pre_indent, q, s, q
+    def html_scalar(s, pre_indent)
+      format '%s%s', pre_indent, span(s)
     end
 
     def sub_hash(key, value, indent)
-      if key == 'href'
-        %Q(#{indentation(indent)}"#{key}"<span>:</span> <a href="#{value}">#{value}</a>)
-      else
-        "#{indentation(indent)}\"#{key}\"<span>:</span> #{to_html(value, indent: indent) }"
-      end
+	  left_side = format '%s%s%s ', indentation(indent), quoted(key), span(':')
+      left_side +
+        if key.to_s == 'href'
+          link(value)
+        else
+          to_html(value, indent: indent)
+        end
     end
 
     def indentation(i)
       "  " * i
     end
 
-    def around(obj)
-      return '"' if obj.is_a? String
-      ""
+    def quoted(obj)
+      case obj
+      when STRUCTURAL_PATTERN
+        obj
+      when String, Symbol
+        format '"%s"', obj
+      when NilClass
+        'null'
+      else
+        obj
+      end
+    end
+
+    def link(href)
+      format '<a href="%s">%s</a>', href, quoted(href)
     end
 
+    def span(value)
+      clazz = span_class(value)
+      value = quoted(value)
+      format '<span class="%s">%s</span>', clazz, value
+    end
+
+    def span_class(obj)
+      case obj
+      when TrueClass, FalseClass
+        'boolean'
+      when NilClass
+        'null'
+      when Numeric
+        'number'
+      when STRUCTURAL_PATTERN
+        'structural'
+      else
+        'string'
+      end
+    end
+
+    def item_separator
+      "#{span ','}\n"
+    end
   end
 end

data/lib/shaf/helpers/payload.rb

@@ -2,49 +2,32 @@
 
 require 'set'
 require 'shaf/responder'
+require 'shaf/parser'
+require 'shaf/errors'
 
 module Shaf
   module Payload
-    EXCLUDED_FORM_PARAMS = ['captures', 'splat'].freeze
+    NO_VALUE = Object.new.freeze
 
     private
 
     def payload
-      @payload ||= parse_payload
-    end
-
-    def read_input
-      request.body.rewind unless request.body.pos.zero?
-      request.body.read
-    ensure
-      request.body.rewind
+      return @payload if defined? @payload
+      @payload = parse_payload
     end
 
     def parse_payload
-      if request.env['CONTENT_TYPE'] == 'application/x-www-form-urlencoded'
-        return params.reject { |key, _| EXCLUDED_FORM_PARAMS.include? key }
-      end
-
-      input = read_input
-      return {} if input.empty?
+      return unless Parser.input? request
 
-      raise raise_unsupported_media_type_error(request) unless suported_media_type?
+      parser = Parser.for(request)
+      raise Errors::UnsupportedMediaTypeError.new(request: request) unless parser
 
-      JSON.parse(input, symbolize_names: true)
-    rescue Errors::UnsupportedMediaTypeError
-      raise
-    rescue StandardError => e
+      log.debug "Parsing input using: #{parser.class}"
+      parser.call
+    rescue Parser::Error => e
       raise Errors::BadRequestError, "Failed to parse input payload: #{e.message}"
     end
 
-    def suported_media_type?
-      request.env['CONTENT_TYPE'].match? %r{\Aapplication/(hal\+)?json}
-    end
-
-    def raise_unsupported_media_type_error(request)
-      raise Errors::UnsupportedMediaTypeError.new(request: request)
-    end
-
     def safe_params(*fields)
       return {} unless payload
 
@@ -57,12 +40,8 @@ module Shaf
       end
     end
 
-    def ignore_form_input?(name)
-      name == '_method'
-    end
-
-    def profile(value = nil)
-      return @profile unless value
+    def profile(value = NO_VALUE)
+      return @profile if value == NO_VALUE
       @profile = value
     end
 
@@ -72,6 +51,7 @@ module Shaf
         status: status,
         serializer: serializer,
         collection: true,
+        preload: preload,
         **kwargs
       )
     end
@@ -80,14 +60,12 @@ module Shaf
       status ||= resource.respond_to?(:http_status) ? resource.http_status : 200
       status(status)
 
-      kwargs.merge!(
-        profile: profile,
-        serializer: serializer,
-        collection: collection
-      )
+      kwargs.merge!(serializer: serializer, collection: collection)
+      kwargs[:profile] ||= profile
 
       log.info "#{request.request_method} #{request.path_info} => #{status}"
-      payload = Responder.for(request, resource).call(self, resource, preload: preload, **kwargs)
+      responder = Responder.for(request, resource)
+      payload = responder.call(self, resource, preload: preload, **kwargs)
       add_cache_headers(payload, kwargs)
       payload
     rescue StandardError => err
@@ -95,6 +73,8 @@ module Shaf
       if status == 500
         content_type mime_type(:json)
         body JSON.generate(failure: err.message)
+      elsif err.is_a? Errors::ServerError
+        respond_with(err)
       else
         respond_with(Errors::ServerError.new(err.message))
       end
@@ -102,10 +82,16 @@ module Shaf
 
     def add_cache_headers(payload, kwargs)
       return unless kwargs.delete(:http_cache) { Settings.http_cache }
+
+      chksum, kind = etag_for(payload)
+      etag(chksum, kind: kind) if chksum
+    end
+
+    def etag_for(payload)
       return if payload.nil? || payload.empty?
 
       sha1 = Digest::SHA1.hexdigest payload
-      etag sha1, :weak # Weak or Strong??
+     [sha1, :weak] # Weak or Strong??
     end
   end
 end

data/lib/shaf/helpers/vary.rb

@@ -0,0 +1,8 @@
+module Shaf
+  module Vary
+    def vary(*varying)
+      current = headers['Vary']
+      headers('Vary' => [current, *varying].compact.join(','))
+    end
+  end
+end