shaf 1.5.1 → 2.1.0

data/templates/api/serializers/error_serializer.rb

@@ -2,13 +2,9 @@ require 'serializers/base_serializer'
 
 class ErrorSerializer < BaseSerializer
   model Shaf::Errors::ServerError
-  profile Shaf::Settings.error_profile_name
+  profile 'shaf-error'
 
   attribute :title
   attribute :code
   attribute :message
-
-  link :profile do
-    Shaf::Settings.error_profile_uri
-  end
 end

data/templates/api/serializers/form_serializer.rb

@@ -3,7 +3,7 @@ require 'shaf/formable'
 
 class FormSerializer < BaseSerializer
   model Shaf::Formable::Form
-  profile Shaf::Settings.form_profile_name
+  profile 'shaf-form'
 
   attribute :method do
     (options[:method] || resource&.method || 'POST').to_s.upcase
@@ -19,10 +19,6 @@ class FormSerializer < BaseSerializer
     options[:self_link] || resource&.self_link
   end
 
-  link :profile do
-    Shaf::Settings.form_profile_uri
-  end
-
   post_serialize do |hash|
     fields = resource&.fields
     next if fields.nil? || fields.empty?

data/templates/api/serializers/validation_error_serializer.rb

@@ -1,14 +1,10 @@
 class ValidationErrorSerializer < BaseSerializer
   model Shaf::Errors::ValidationError
-  profile Shaf::Settings.error_profile_name
+  profile 'shaf-error'
 
   attribute :title
   attribute :code
   attribute :fields do
     resource.fields
   end
-
-  link :profile do
-    Shaf::Settings.error_profile_uri
-  end
 end

data/templates/config.ru

@@ -1,4 +1,4 @@
 $:.unshift File.expand_path(__dir__)
 require 'config/bootstrap'
 
-Shaf::App.run!
+run Shaf::App

data/templates/config/bootstrap.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-$logger = nil
-
 require 'shaf'
 if ENV['RACK_ENV'] == 'test'
   require 'minitest'
@@ -15,3 +13,4 @@ require 'config/database'
 require 'config/initializers'
 require 'config/directories'
 require 'config/helpers'
+

data/templates/config/directories.rb

@@ -1,53 +1,61 @@
 require 'shaf/settings'
 
-def sort_files(files)
-  files.sort_by do |file|
-    directory_priority(file) + file_priority(file)
-  end
-end
+module Shaf
+  module Directories
+    class << self
+      def require_ruby_files
+        files = Dir[File.join('**', '*.rb')]
+        sort_files(files).each do |file|
+          # load all files with .rb extension in subfolders of api
+          Shaf.log.debug "Require file: #{file}"
+          require file
+        end
+      end
 
-def directory_priority(file)
-  case file
-  when /\Alib/
-    0
-  when /\Ahelpers/
-    10
-  when /\Amodels/
-    20
-  when /\Apolicies/
-    30
-  when /\Acontrollers/
-    40
-  when /\Aserializers/
-    50
-  else
-    60
-  end
-end
+      private
 
-def file_priority(file)
-  case File.basename(file)
-  when /\Abase[\._]/
-    0
-  else
-    9
-  end
-end
+      def sort_files(files)
+        files.sort_by do |file|
+          directory_priority(file) + file_priority(file)
+        end
+      end
 
-def require_ruby_files
-  files = Dir[File.join('**', '*.rb')]
-  sort_files(files).each do |file|
-    # load all files with .rb extension in subfolders of api
-    $logger&.debug "Require file: #{file}"
-    require file
-  end
-end
+      def directory_priority(file)
+        case file
+        when /\Alib/
+          0
+        when /\Ahelpers/
+          10
+        when /\Amodels/
+          20
+        when /\Apolicies/
+          30
+        when /\Acontrollers/
+          40
+        when /\Aserializers/
+          50
+        else
+          60
+        end
+      end
+
+      def file_priority(file)
+        case File.basename(file)
+        when /\Abase[\._]/
+          0
+        else
+          9
+        end
+      end
+    end
 
-%i[lib_dir src_dir app_dir].each do |cfg|
-  dir = Shaf::Settings.send cfg
-  next unless Dir.exist? dir
+    %i[lib_dir src_dir app_dir].each do |cfg|
+      dir = Shaf::Settings.send cfg
+      next unless Dir.exist? dir
 
-  Dir.chdir(dir) do
-    require_ruby_files
+      Dir.chdir(dir) do
+        require_ruby_files
+      end
+    end
   end
 end

data/templates/config/helpers.rb

@@ -11,7 +11,7 @@ if Dir.exist? dir
     end
     modules.compact!
     modules.each do |mod|
-      $logger&.debug "helper: #{mod}"
+      Shaf.log.debug "helper: #{mod}"
       BaseController.send(:class_eval, "helpers #{mod}")
     end
   end

data/templates/config/initializers.rb

@@ -1,12 +1,56 @@
-if File.exist?  'config/initializers/logging.rb'
-  require "config/initializers/logging"
-end
+# frozen_string_literal: true
+
+require 'set'
+require 'shaf/errors'
+
+module Shaf
+  class Initializer
+    attr_reader :file
+
+    class NoSuchInitializer < Shaf::Error
+      def initialize(file)
+        super "Initializer \"#{file}\" does not exist"
+      end
+    end
+
+    INITIALIZERS_PATH = File.expand_path('../initializers', __FILE__)
+
+    class << self
+      def load(file)
+        new(file).load
+      end
+
+      def load_all
+        files.each { |file| Initializer.load(file) }
+      end
+
+      private
+
+      def files
+        Dir.chdir(INITIALIZERS_PATH) do
+          Set['logging.rb'].merge Dir['*.rb']
+        end
+      end
+    end
+
+    def initialize(file)
+      file = "#{file}.rb" unless file.end_with? '.rb'
+      @file = file
+    end
+
+    def content
+      Dir.chdir(INITIALIZERS_PATH) do
+        raise NoSuchInitializer, file unless ::File.exist? file
+        ::File.read(file)
+      end
+    end
 
-Dir.chdir(File.expand_path('initializers', __dir__)) do
-  Dir['*.rb'].each do |file|
-    lib = File.basename(file, '.rb')
-    require "config/initializers/#{lib}" or next
-    $logger&.debug "Loading initializer: #{lib}"
+    def load
+      name = File.basename(file, '.rb')
+      Shaf.log.debug "Loading initializer: #{name}"
+      instance_eval content
+    end
   end
 end
 
+Shaf::Initializer.load_all

data/templates/config/initializers/authentication.rb

@@ -0,0 +1,18 @@
+# Write one more Authentication strategies here. Shaf only supports Basic Auth
+# by default but additional authenticators may be written. See
+# https://github.com/sammyhenningsson/shaf/blob/master/doc/AUTHENTICATION.md
+# for more info.
+#
+# Examples:
+#
+# Shaf::Authenticator::BasicAuth.restricted realm: 'user' do |user:, password:|
+#   return unless user && password
+#   password_hash = Digest::SHA256.hexdigest(password)
+#   User.where(username: user, password_hash: password_hash).first
+# end
+#
+# Shaf::Authenticator::BasicAuth.restricted realm: 'admin' do |user:, password:|
+#   return unless user && password
+#   password_hash = Digest::SHA256.hexdigest(password)
+#   User.where(username: user, password_hash: password_hash, admin: true).first
+# end

data/templates/config/initializers/db_migrations.rb

@@ -35,7 +35,7 @@ class DbMigrations
   end
 
   def migrate
-    $logger&.info "Running migrations in #{environment} environment.."
+    Shaf.log.info "Running migrations in #{environment} environment.."
     Sequel::Migrator.run(DB, migrations_dir)
   end
 
@@ -43,7 +43,7 @@ class DbMigrations
     msg = "Database for environment '#{environment}' is not " \
       'updated to the latest migration'
     STDERR.puts msg
-    $logger&.warn msg
+    Shaf.log.warn msg
   end
 end
 

data/templates/config/initializers/logging.rb

@@ -3,5 +3,5 @@ require 'logger'
 log_dir = File.join(Shaf::Settings.app_root, 'logs')
 Dir.mkdir log_dir unless Dir.exist? log_dir
 
-$logger = Logger.new(File.join(log_dir, "#{Sinatra::Application.settings.environment}.log"))
-DB.loggers << $logger
+Shaf.logger = Logger.new(File.join(log_dir, "#{Sinatra::Application.settings.environment}.log"))
+DB.loggers << Shaf.logger if defined? DB

data/templates/frontend/assets/css/main.css

@@ -16,10 +16,18 @@ ul {
   list-style-type: none;
 }
 
+td {
+  min-width: 20em;
+}
+
 pre {
   margin: 0;
 }
 
+main {
+  padding-bottom: 8em;
+}
+
 .container {
   display: flex;
   flex-direction: row;
@@ -33,6 +41,10 @@ pre {
   height: 100%;
 }
 
+.headers {
+  margin-bottom: 2em;
+}
+
 .hal-form {
   height: auto;
   display: flex;
@@ -60,11 +72,31 @@ pre {
   min-height: 100%;
   height: auto;
   overflow: auto;
-  background-color: #b5aeae;
+  background-color: #e0e0e0;
   display: flex;
   flex-direction: row;
   justify-content: flex-start;
   align-items: flex-start;
   padding: 1em;
+  border-radius: 20px;
+}
+
+span.boolean {
+  color: #0277BD;
 }
 
+span.null {
+  color: #757575;
+}
+
+span.number {
+  color: #3F51B5;
+}
+
+span.structural {
+  color: black;
+}
+
+span.string {
+  color: #43A047;
+}

data/templates/frontend/views/headers.erb

@@ -0,0 +1,20 @@
+<div class="container">
+  <section class="section headers">
+    <h3><%= title %></h3>
+    <table class="hal-payload">
+      <% headers.each do |key, value| %>
+        <tr>
+          <td><%= key %></td>
+          <td><%= value %></td>
+        </tr>
+      <% end %>
+    </table>
+    <ul>
+    <% notes.each do |note| %>
+      <li>
+        <p><sub><%= note %></sub></p>
+      </li>
+    <% end %>
+    </ul>
+  </section>
+</div>

data/templates/frontend/views/layout.erb

@@ -6,6 +6,12 @@
     <link rel="stylesheet" type="text/css" href="/css/main.css">
   </head>
   <body>
-    <%= yield %>
+    <div class="main-container">
+      <main>
+        <%= yield %>
+      </main>
+      <%= erb :headers, locals: {title: 'Request headers', headers: request_headers, notes: []} %>
+      <%= erb :headers, locals: {title: 'Response headers', headers: response_headers, notes: ["This is an example of a response to a request with Accept: #{response_headers['Content-Type']}. YMMV"]} %>
+    </div>
   </body>
 </html>

data/templates/frontend/views/payload.erb

@@ -1,6 +1,7 @@
 <% @page_title = "HAL payload" %>
 <div class="container">
   <section class="section">
+    <h3>Response</h3>
     <div class="hal-payload">
       <%= as_html(serialized) %>
     </div>

data/templates/spec/spec_helper.rb

@@ -3,3 +3,5 @@ require 'config/bootstrap'
 require 'minitest/autorun'
 require 'minitest/hooks'
 require 'shaf/spec'
+
+Shaf::Spec::Authenticator.restricted { |id:| User[id] }

data/yard_templates/api_doc/doc_index/html/body.erb

@@ -0,0 +1,3 @@
+<div class="resource">
+  <h2>Welcome to the API documentation for <%= Shaf::Settings.project_name %>!
+</div>

data/yard_templates/api_doc/doc_index/setup.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+def init
+  super
+
+  sections :body
+end
+