shaf 1.5.0 → 2.0.0

data/lib/shaf/yard/link_method_handler.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'shaf/yard/base_method_handler'
+
+module Shaf
+  module Yard
+    # Handles call to Shaf::Serializer::link
+    class LinkMethodHandler < BaseMethodHandler
+      handles method_call(:link)
+
+      def object
+        LinkObject.new(serializer_namespace, name).tap do |link|
+          link.dynamic = true
+          link.rel = name
+          link.curie = curie
+        end
+      end
+
+      def name
+        super.sub(/[^:]+:/, '')
+      end
+
+      def curie
+        m = name.match(/([^:]+):/)
+        return m[1] if m
+
+        statement.parameters(false).each do |param|
+          next unless param&.respond_to? :source
+
+          str = String(param.source)
+          m = str.match(/curie:\s:?(\w+)/)
+          return m[1] if m
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/shaf/yard/link_object.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'shaf/api_doc/link_relations'
+
+module Shaf
+  module Yard
+    class LinkObject < ::YARD::CodeObjects::Base
+      attr_accessor :rel, :curie
+
+      def curie?
+        !!curie
+      end
+
+      def documentation
+        profile_doc || iana_doc || 'Undocumented'
+      end
+
+      def profile_object
+        return unless profile
+        return unless namespace.respond_to? :profile_objects
+
+        namespace.profile_objects.find do |po|
+          po.profile == profile
+        end
+      end
+
+      def profile
+        return @profile if defined? @profile
+        return unless namespace.respond_to? :profile
+        profile = namespace.profile
+        @profile = profile&.find_relation(name) && profile
+      end
+
+      def descriptor
+        profile&.find_relation(rel)
+      end
+
+      def profile_doc
+        descriptor&.doc
+      end
+
+      def http_methods
+        Array(descriptor&.http_methods)
+      end
+
+      def href
+        descriptor&.href
+      end
+
+      def content_type
+        descriptor&.content_type
+      end
+
+      def iana_doc
+        ApiDoc::LinkRelations.load_iana
+        ApiDoc::LinkRelations[name.to_sym]&.description
+      end
+    end
+  end
+end

data/lib/shaf/yard/nested_attributes.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Yard
+    module NestedAttributes
+      def nested_attributes_for(descriptor)
+        return {} unless descriptor
+
+        base_key = nested_key(descriptor)
+        nested_attributes(descriptor)
+          .yield_self { |nested| flatten(nested, base_key) }
+      end
+
+      def nested_attributes(descriptor)
+        attrs = Array(descriptor&.attributes)
+        attrs.each_with_object({}) do |attr, nested|
+          nested[attr] = nested_attributes(attr)
+        end.transform_values { |v| v.empty? ? nil : v }
+      end
+
+      def flatten(nested, base_key)
+        return {} if !nested || nested.empty?
+
+        nested.each_with_object({}) do |(desc, nested), all|
+          key = nested_key(base_key, desc)
+          all[key] = desc
+          next unless nested
+          all.merge!(flatten(nested, key))
+        end
+      end
+
+      def nested_key(base_key = nil, desc)
+        [base_key, desc.name].compact.join('.')
+      end
+    end
+  end
+end

data/lib/shaf/yard/parser.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Yard
+    class Parser
+      def self.call(name: '')
+        new(name).parse!
+      end
+
+      def initialize(name)
+        @name = name.downcase
+      end
+
+      def parse!
+        verify_exists! unless name.empty?
+        ::YARD.parse pattern
+      end
+
+      private
+
+      attr_reader :name
+
+      def pattern
+        return file_path if file_path
+
+        base = ['*', suffix].join
+        File.join(base_dir, '**', base)
+      end
+
+      def suffix
+        '_serializer.rb'
+      end
+
+      def verify_exists!
+        file_path or raise <<~ERR
+          Could not find a matching serializer for #{name}.
+          Looked in: #{base_dir}
+          Using suffix: #{suffix}
+        ERR
+      end
+
+      def file_path
+        @file_path ||= lookup_path
+      end
+
+      def base_dir
+        File.join(Shaf::Settings.app_dir || 'api', 'serializers')
+      end
+
+      def lookup_path
+        return if name.empty?
+
+        path = File.join(base_dir, name)
+        return path if File.exist? path
+
+        with_suffix = [path, suffix].join
+        return with_suffix if File.exist? with_suffix
+
+        with_extension = [path, '.rb'].join
+        with_extension if File.exist? with_extension
+      end
+    end
+  end
+end

data/lib/shaf/yard/profile_method_handler.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'shaf/yard/base_method_handler'
+require 'shaf/profiles'
+require 'shaf/utils'
+
+module Shaf
+  module Yard
+    # Handles call to Shaf::Serializer::profile
+    class ProfileMethodHandler < BaseMethodHandler
+      include Shaf::Utils
+
+      handles method_call(:profile)
+
+      def process
+        serializer = serializer_namespace
+        profile = shaf_profile
+        return unless serializer
+
+        serializer.profile = profile
+
+        register object
+        serializer_namespace.profile_objects << object
+      end
+
+      def shaf_profile
+        return @shaf_profile if defined? @shaf_profile
+
+        bootstrap(env: ENV['RACK_ENV'])
+
+        @shaf_profile = Shaf::Profiles.find name
+      end
+
+      def object
+        # Put the Profile object on the the same namespace level as
+        # the serializer. Typically this it the root namespace
+        ns = namespace.namespace
+
+        name = shaf_profile&.to_s || self.name
+        name.gsub!(/(Shaf|Profiles)?::/, "")
+
+        name << "Profile" unless name.end_with? "Profile"
+
+        ProfileObject.new(ns, name).tap do |obj|
+          obj.dynamic = true
+          obj.profile = shaf_profile
+        end
+      end
+    end
+  end
+end

data/lib/shaf/yard/profile_object.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Yard
+    class ProfileObject < ::YARD::CodeObjects::ClassObject
+      attr_accessor :profile
+
+      def path
+        "Profiles::#{name}"
+      end
+
+      def description
+        profile&.doc || ""
+      end
+      
+      def profile_name
+        name.to_s.sub(/Profile\z/, '')
+      end
+    end
+  end
+end

data/lib/shaf/yard/resource_object.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Yard
+    class ResourceObject < ::YARD::CodeObjects::ClassObject
+      attr_accessor :profile
+
+      def self.path(*args, sep: '::')
+        ['Serializers', *args].join(sep)
+      end
+
+      def path
+        self.class.path(super, sep: sep)
+      end
+
+      def attributes
+        children.select { |child| child.type == :attribute }
+                .sort_by(&:name)
+      end
+
+      def links
+        children.select { |child| child.type == :link }
+                .sort_by(&:name)
+      end
+
+      def resource_name
+        str = name.to_s.sub(/_?serializer$/i, '')
+        return str unless str.match? '_'
+
+        str.split('_')
+           .map(&:capitalize)
+           .join
+      end
+
+      def profile?
+        !!profile
+      end
+
+      def profile_name
+        return '' unless profile?
+
+        profile.name
+      end
+
+      def profile_objects
+        @profile_objects ||= []
+      end
+
+      def description
+        # TODO: How to add description? @description tag in serializer?
+        ''
+      end
+    end
+  end
+end

data/lib/shaf/yard/serializer_handler.rb

@@ -0,0 +1,27 @@
+module Shaf
+  module Yard
+    class SerializerHandler < ::YARD::Handlers::Ruby::Base
+      handles :class
+
+      process do
+        next unless serializer?
+
+        register object
+      end
+
+      def name
+        statement[0].source
+      end
+
+      def serializer?
+        name.match? %r{Serializer$}
+      end
+
+      def object
+        ResourceObject.new(namespace, name).tap do |obj|
+          obj.dynamic = true
+        end
+      end
+    end
+  end
+end

data/templates/api/controllers/base_controller.rb

@@ -11,8 +11,6 @@ class BaseController < Sinatra::Base
     set :public_folder, Shaf::Settings.public_folder
     disable :dump_errors
     set :show_exceptions, :after_handler
-    enable :current_user
-    set :auth_token_header, Shaf::Settings.auth_token_header
   end
 
   use Rack::Deflater
@@ -26,7 +24,6 @@ class BaseController < Sinatra::Base
     log.info "Processing: #{request.request_method} #{request.path_info}"
     log.debug "Headers: #{request_headers}"
     log.debug "Payload: #{payload || 'empty'}"
-    set_vary_header
   end
 
   not_found do
@@ -47,13 +44,6 @@ class BaseController < Sinatra::Base
     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 api_error(err)
     case err
     when Shaf::Authorize::PolicyViolationError

data/templates/api/controllers/docs_controller.rb

@@ -1,14 +1,16 @@
 class DocsController < BaseController
 
-  register_uri :doc_curie,      '/doc/:resource/rels/{rel}'
+  register_uri :profile,        '/doc/profiles/:name'
+  register_uri :doc_curie,      '/doc/profiles/:name{#rel}'
   register_uri :documentation,  '/doc/:resource'
 
   before_action do
     cache_control(:private, http_cache_max_age: :long)
   end
 
-  get :doc_curie_path do
-    respond_with doc, path: request.path_info, rel: params[:rel]
+  # Note: This route handles both :profile_path and :doc_curie_path
+  get :profile_path do
+    respond_with Shaf::Profiles.find!(params[:name])
   end
 
   get :documentation_path do

data/templates/api/controllers/root_controller.rb

@@ -2,8 +2,14 @@ class RootController < BaseController
 
   register_uri :root, '/'
 
-  get :root_uri do
+  get :root_path do
     cache_control(:private, http_cache_max_age: :long)
+    # Uncomment the line below (and change realm if you like) if your api has
+    # resources that requires authentication. See
+    # https://github.com/sammyhenningsson/shaf/blob/master/doc/AUTHENTICATION.md
+    # for more info.
+    # www_authenticate realm: 'MyApi'
+    
     respond_with nil, serializer: RootSerializer
   end
 end

data/templates/api/policies/base_policy.rb

@@ -1,3 +1,5 @@
 class BasePolicy
   include HALPresenter::Policy::DSL
+
+  link :profile
 end

data/templates/api/serializers/base_serializer.rb

@@ -1,4 +1,2 @@
-class BaseSerializer
-  extend HALPresenter
-  extend Shaf::UriHelper
+class BaseSerializer < Shaf::Serializer
 end