shaf 1.5.1 → 2.1.0

data/yard_templates/api_doc/sidebar/html/sidebar.erb

@@ -0,0 +1,13 @@
+<div class="sidebar">
+  <div class="sidebar-tabs">
+    <button class="sidebar-tab-btn<%= ' active' if resource? || index?  %>" onclick="openTab(event, 'serializer-list')">
+      Resources
+    </button>
+    <button class="sidebar-tab-btn<%= ' active' if profile? %>" onclick="openTab(event, 'profile-list')">
+      Profiles
+    </button>
+  </div>
+  <div class="sidebar-container">
+    <%= yieldall %>
+  </div>
+</div>

data/yard_templates/api_doc/sidebar/setup.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'set'
+
+def init
+  super
+
+  @resources = resources
+  @profiles = profiles
+
+  sections :sidebar, %i[serializer_list profile_list]
+end
+
+def resources
+  options.resources.map do |resource|
+    path = resource.path.sub(/Serializers::/, '')
+
+    {
+      name: resource.resource_name,
+      path: "/api_doc/#{path}.html"
+    }
+  end.sort_by { |h| h[:name] }
+end
+
+def profiles
+  options.profiles.map do |profile|
+    path = profile.path.sub(/Profiles::/, '')
+
+    {
+      name: profile.profile_name,
+      path: "/api_doc/#{path}.html"
+    }
+  end.sort_by { |h| h[:name] }
+end
+
+def profile?
+  object.is_a? Shaf::Yard::ProfileObject
+end
+
+def resource?
+  object.is_a? Shaf::Yard::ResourceObject
+end
+
+def index?
+  object.type == :doc_index
+end
+
+def resource_active?(name)
+  return false unless resource?
+  object.resource_name == name
+end
+
+def profile_active?(name)
+  return false unless profile?
+  object.profile_name == name
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -10,28 +10,41 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDXjCCAkagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFzYW1t
-  eS5oZW5uaW5nc3Nvbi9EQz1nbWFpbC9EQz1jb20wHhcNMTgwNzE2MTYzNTMzWhcN
-  MjAwNzE2MTYzNTMzWjAsMSowKAYDVQQDDCFzYW1teS5oZW5uaW5nc3Nvbi9EQz1n
-  bWFpbC9EQz1jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvkgwt
-  Zn8obnCelWttayB1BrHBLUK3b8gasRRtbNk4DzAL+EW6sHSVT2u5I7Wws7JQA5VB
-  NaK7tgvq3CbDLVRl9NrpDCDx09To08stPxDKi6kst1nkSPAD8g0sQlW3voeQTH98
-  2Z2H3XUegHhu5Z9PU9T/7V/vZUzHPiPg1tX1JUIGOPAjVGsr7SUetbL171zK4S4Y
-  tvUkIoNaph+maHttvyYB/ptiZLD53WORKd4Knw3OiJsLtrxr5hhKyQ+txQdF0P8G
-  +FlR+Je7B0Ek3yg6fEiJgrdcajYCMo8Oe/GRtoHhi6J3LsYA620P1BSCddZQ2XeL
-  y3rzIZyMU0iaT69nAgMBAAGjgYowgYcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
-  HQYDVR0OBBYEFLpI49QndnmuiDhwy2XtMps7No1pMCYGA1UdEQQfMB2BG3NhbW15
-  Lmhlbm5pbmdzc29uQGdtYWlsLmNvbTAmBgNVHRIEHzAdgRtzYW1teS5oZW5uaW5n
-  c3NvbkBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQADggEBAFJZqH6sgeiTLvMLpxaK
-  K1GaYSCyZbMutf5C3tIAgkmU5UD6B8R0bw6gTM1deM5NJ60LjzqY7rlK3YKDIbTn
-  iXMCe9vd4yE/jb5Zi8Wk//9n8CMG68dQpBvmcQ58/M4gTtgsx+lIgXuI5dPQMmRi
-  bhWQqqWqxT9X6njjfXFk4xn3z6mfFQNPAYqRVeTHUpXBQZPt+bYXRwHPFZGWkx4l
-  BnuuhYKt3CR7YIgvnsQWlTAcU1Ipdayj6UfYqUtlc6cF3CL96NOx7mgZXV8URFiX
-  ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
-  M40=
+  MIIDVjCCAj6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9zYW1t
+  eS5oZW5uaW5nc3Nvbi9EQz1oZXkvREM9Y29tMB4XDTIxMDIwMjEzNTY1OFoXDTIy
+  MDIwMjEzNTY1OFowKjEoMCYGA1UEAwwfc2FtbXkuaGVubmluZ3Nzb24vREM9aGV5
+  L0RDPWNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK+SDC1mfyhu
+  cJ6Va21rIHUGscEtQrdvyBqxFG1s2TgPMAv4RbqwdJVPa7kjtbCzslADlUE1oru2
+  C+rcJsMtVGX02ukMIPHT1OjTyy0/EMqLqSy3WeRI8APyDSxCVbe+h5BMf3zZnYfd
+  dR6AeG7ln09T1P/tX+9lTMc+I+DW1fUlQgY48CNUayvtJR61svXvXMrhLhi29SQi
+  g1qmH6Zoe22/JgH+m2JksPndY5Ep3gqfDc6Imwu2vGvmGErJD63FB0XQ/wb4WVH4
+  l7sHQSTfKDp8SImCt1xqNgIyjw578ZG2geGLoncuxgDrbQ/UFIJ11lDZd4vLevMh
+  nIxTSJpPr2cCAwEAAaOBhjCBgzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQUukjj1Cd2ea6IOHDLZe0ymzs2jWkwJAYDVR0RBB0wG4EZc2FtbXkuaGVu
+  bmluZ3Nzb25AaGV5LmNvbTAkBgNVHRIEHTAbgRlzYW1teS5oZW5uaW5nc3NvbkBo
+  ZXkuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQBt310FZ56E/fp/y5Wym1xb4C0owfnI
+  LzUqOjXWZTO7RezlBJV/qIwqt6bEjYDQR56zULJFSp4YdoDsratmQ+/kwtbHF7xf
+  WYkSE36mhLP2ggQFH9fXtX6XdyIlwFqwEfNW73ZrkBXGjMxLVKIS9uHdN7PoNhbS
+  0YjOZZD/rq1Jf+klwl/G7bBDPjn58DWlUmwzoj49goGS/UBG37RssQxRwPelKHZh
+  5ZlcHq9h5CxVt380OKaU6wMg95RJBd/kUJqmPxxlxMH8QDQinTwZmmFA9wW7PJdy
+  wAx8px9LkSjTs0GVLH7VtVRWAELllsswCJktz63Adelx9fmIMgrTYgZM
   -----END CERTIFICATE-----
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: file_transactions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -39,9 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,9 +62,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +135,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +211,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 description: A framework for building hypermedia driven APIs with sinatra and sequel.
 email: sammy.henningsson@gmail.com
 executables:
@@ -200,10 +227,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/shaf
+- iana_link_relations.csv.gz
 - lib/shaf.rb
+- lib/shaf/alps/attribute_serializer.rb
+- lib/shaf/alps/json_serializer.rb
+- lib/shaf/alps/relation_serializer.rb
 - lib/shaf/api_doc/comment.rb
 - lib/shaf/api_doc/document.rb
+- lib/shaf/api_doc/link_relations.rb
 - lib/shaf/app.rb
+- lib/shaf/authenticator.rb
+- lib/shaf/authenticator/base.rb
+- lib/shaf/authenticator/basic_auth.rb
+- lib/shaf/authenticator/challenge.rb
+- lib/shaf/authenticator/parameter.rb
+- lib/shaf/authenticator/request.rb
 - lib/shaf/command.rb
 - lib/shaf/command/base.rb
 - lib/shaf/command/console.rb
@@ -211,6 +249,7 @@ files:
 - lib/shaf/command/new.rb
 - lib/shaf/command/server.rb
 - lib/shaf/command/templates/Gemfile.erb
+- lib/shaf/command/templates/config/settings.yml.erb
 - lib/shaf/command/test.rb
 - lib/shaf/command/test/filter.rb
 - lib/shaf/command/test/runnable_method.rb
@@ -219,9 +258,9 @@ files:
 - lib/shaf/command/version.rb
 - lib/shaf/errors.rb
 - lib/shaf/extensions.rb
+- lib/shaf/extensions/api_routes.rb
 - 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
@@ -232,6 +271,7 @@ files:
 - lib/shaf/generator.rb
 - lib/shaf/generator/base.rb
 - lib/shaf/generator/controller.rb
+- lib/shaf/generator/doc.rb
 - lib/shaf/generator/forms.rb
 - lib/shaf/generator/helper.rb
 - lib/shaf/generator/migration.rb
@@ -246,39 +286,59 @@ files:
 - lib/shaf/generator/migration/types.rb
 - lib/shaf/generator/model.rb
 - lib/shaf/generator/policy.rb
+- lib/shaf/generator/profile.rb
 - lib/shaf/generator/scaffold.rb
 - lib/shaf/generator/serializer.rb
 - lib/shaf/generator/templates/api/controller.rb.erb
 - lib/shaf/generator/templates/api/forms.rb.erb
 - lib/shaf/generator/templates/api/model.rb.erb
 - lib/shaf/generator/templates/api/policy.rb.erb
+- lib/shaf/generator/templates/api/profile.rb.erb
 - lib/shaf/generator/templates/api/serializer.rb.erb
 - lib/shaf/generator/templates/spec/integration_spec.rb.erb
 - lib/shaf/generator/templates/spec/model.rb.erb
 - lib/shaf/generator/templates/spec/serializer_spec.rb.erb
 - lib/shaf/helpers.rb
+- lib/shaf/helpers/authentication.rb
 - lib/shaf/helpers/cache_control.rb
 - lib/shaf/helpers/http_header.rb
 - lib/shaf/helpers/json_html.rb
 - lib/shaf/helpers/paginate.rb
 - lib/shaf/helpers/payload.rb
+- lib/shaf/helpers/vary.rb
 - lib/shaf/immutable_attr.rb
+- lib/shaf/logger.rb
 - lib/shaf/middleware.rb
 - lib/shaf/middleware/request_id.rb
+- lib/shaf/parser.rb
+- lib/shaf/parser/base.rb
+- lib/shaf/parser/form_data.rb
+- lib/shaf/parser/json.rb
+- lib/shaf/profile.rb
+- lib/shaf/profile/attribute.rb
+- lib/shaf/profile/evaluator.rb
+- lib/shaf/profile/relation.rb
+- lib/shaf/profile/unique_id.rb
+- lib/shaf/profiles.rb
+- lib/shaf/profiles/shaf_basic.rb
+- lib/shaf/profiles/shaf_error.rb
+- lib/shaf/profiles/shaf_form.rb
 - lib/shaf/rake.rb
 - lib/shaf/rake/db.rb
 - lib/shaf/rake/test.rb
 - lib/shaf/registrable_factory.rb
 - lib/shaf/resource_doc.rb
 - lib/shaf/responder.rb
+- lib/shaf/responder/alps_json.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
+- lib/shaf/serializer.rb
 - lib/shaf/settings.rb
 - lib/shaf/spec.rb
+- lib/shaf/spec/authenticator.rb
 - lib/shaf/spec/base.rb
 - lib/shaf/spec/fixture.rb
 - lib/shaf/spec/fixtures.rb
@@ -290,6 +350,7 @@ files:
 - lib/shaf/spec/payload_utils.rb
 - lib/shaf/spec/serializer_spec.rb
 - lib/shaf/spec/system_spec.rb
+- lib/shaf/supported_http_methods.rb
 - lib/shaf/tasks.rb
 - lib/shaf/tasks/api_doc_task.rb
 - lib/shaf/tasks/db_task.rb
@@ -301,6 +362,18 @@ files:
 - lib/shaf/upgrade/version.rb
 - lib/shaf/utils.rb
 - lib/shaf/version.rb
+- lib/shaf/yard.rb
+- lib/shaf/yard/attribute_method_handler.rb
+- lib/shaf/yard/attribute_object.rb
+- lib/shaf/yard/base_method_handler.rb
+- lib/shaf/yard/link_method_handler.rb
+- lib/shaf/yard/link_object.rb
+- lib/shaf/yard/nested_attributes.rb
+- lib/shaf/yard/parser.rb
+- lib/shaf/yard/profile_method_handler.rb
+- lib/shaf/yard/profile_object.rb
+- lib/shaf/yard/resource_object.rb
+- lib/shaf/yard/serializer_handler.rb
 - templates/Rakefile
 - templates/api/controllers/base_controller.rb
 - templates/api/controllers/docs_controller.rb
@@ -320,14 +393,15 @@ files:
 - templates/config/directories.rb
 - templates/config/helpers.rb
 - templates/config/initializers.rb
+- templates/config/initializers/authentication.rb
 - templates/config/initializers/db_migrations.rb
 - templates/config/initializers/hal_presenter.rb
 - templates/config/initializers/logging.rb
 - templates/config/initializers/sequel.rb
 - templates/config/paths.rb
-- templates/config/settings.yml
 - templates/frontend/assets/css/main.css
 - templates/frontend/views/form.erb
+- templates/frontend/views/headers.erb
 - templates/frontend/views/layout.erb
 - templates/frontend/views/payload.erb
 - templates/spec/integration/root_spec.rb
@@ -345,6 +419,42 @@ files:
 - upgrades/1.3.0.tar.gz
 - upgrades/1.4.0.tar.gz
 - upgrades/1.5.0.tar.gz
+- upgrades/1.6.0.tar.gz
+- upgrades/1.6.1.tar.gz
+- upgrades/2.0.0.tar.gz
+- yard_templates/api_doc/doc_index/html/body.erb
+- yard_templates/api_doc/doc_index/setup.rb
+- yard_templates/api_doc/html/css/api-doc.css
+- yard_templates/api_doc/html/favicon.ico
+- yard_templates/api_doc/html/js/switch_tab.js
+- yard_templates/api_doc/html/setup.rb
+- yard_templates/api_doc/layout/html/footer.erb
+- yard_templates/api_doc/layout/html/header.erb
+- yard_templates/api_doc/layout/html/layout.erb
+- yard_templates/api_doc/layout/setup.rb
+- yard_templates/api_doc/profile/html/attributes.erb
+- yard_templates/api_doc/profile/html/profile.erb
+- yard_templates/api_doc/profile/html/relations.erb
+- yard_templates/api_doc/profile/setup.rb
+- yard_templates/api_doc/profile_attribute/html/attribute.erb
+- yard_templates/api_doc/profile_attribute/setup.rb
+- yard_templates/api_doc/profile_relation/html/relation.erb
+- yard_templates/api_doc/profile_relation/setup.rb
+- yard_templates/api_doc/resource/html/attributes.erb
+- yard_templates/api_doc/resource/html/profile.erb
+- yard_templates/api_doc/resource/html/relations.erb
+- yard_templates/api_doc/resource/html/resource.erb
+- yard_templates/api_doc/resource/setup.rb
+- yard_templates/api_doc/resource_attribute/html/attribute.erb
+- yard_templates/api_doc/resource_attribute/setup.rb
+- yard_templates/api_doc/resource_relation/html/relation.erb
+- yard_templates/api_doc/resource_relation/setup.rb
+- yard_templates/api_doc/setup.rb
+- yard_templates/api_doc/sidebar/html/profile_list.erb
+- yard_templates/api_doc/sidebar/html/search.erb
+- yard_templates/api_doc/sidebar/html/serializer_list.erb
+- yard_templates/api_doc/sidebar/html/sidebar.erb
+- yard_templates/api_doc/sidebar/setup.rb
 homepage: 
 licenses:
 - MIT

data/lib/shaf/extensions/current_user.rb

@@ -1,48 +0,0 @@
-require 'digest'
-
-module Shaf
-  module CurrentUser
-    def self.registered(settings)
-      return unless settings.respond_to?(:current_user) && settings.current_user
-
-      settings.log.info 'Using Shaf::CurrentUser'
-      settings.helpers Helpers
-    end
-
-    def self.digest(token)
-      Digest::SHA256.hexdigest(token) if token
-    end
-  end
-
-  module Helpers
-    ERR_MSG = 'The default Shaf implementation of #current_user requires a ' \
-      'User model with a column auth_token_digest'.freeze
-
-    def auth_token
-      header = Utils.rackify_header(settings.auth_token_header)
-      request.env[header]
-    end
-
-    def current_user
-      return @current_user if defined?(@current_user)
-
-      return unless check_user_model
-      digest = Shaf::CurrentUser.digest(auth_token) || return
-      @current_user = User.where(auth_token_digest: digest).first
-    end
-
-    def authenticated?
-      !current_user.nil?
-    end
-
-    def authenticate!
-      authenticated? || raise(Shaf::Errors::UnauthorizedError)
-    end
-
-    def check_user_model
-      return true if defined?(User) && User.columns.include?(:auth_token_digest)
-      log.warn ERR_MSG
-      false
-    end
-  end
-end

data/lib/shaf/responder/hal_serializable.rb

@@ -1,54 +0,0 @@
-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