linked_rails 0.0.4.pre.g14b377f91 → 0.0.4.pre.g72bb595fe

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad7cb510016bb7b42c2b472031bb0eebcd976cd93f0a20cfca9f70b87271a4c9
-  data.tar.gz: 5965b0ffb3715273ed446f29d3544124145b06162a66c866f899731c85819acb
+  metadata.gz: 7810fdc42df9533cc1828c33aec04953486145ee0c744607b01b5f514d67dcb0
+  data.tar.gz: 9056187a625becc1c3e4c234ae7b06b77e77f0d4d3bdcb5d6c24b1249e1e21a9
 SHA512:
-  metadata.gz: 7f82190e18c85082737f30ff5ed4b5ef1e13cf90b5a3b2c8941589a8812eb79dbf34948005a28895c6aa12884134c66e869258374759506bb7b1642829072773
-  data.tar.gz: 3abb5a9fe9fedde3040d55d89f2a3af74d13e97f93b07dca126a6dcbebcfd27309cee9548b0b95b09dec84cdc6519acd6f44c8e11a4d978e47eca82c4ee88cca
+  metadata.gz: d294b57b181d6995d88ee5967c61d9bd5c69a2a1e3dc6843848032c4f9ee36c7c762d2f163022e97cdd35219bc6d395392b0af9863ab7f0a4dcb924f5c4358ef
+  data.tar.gz: 880a18f47ab624f736ab12421c3ea8c6a4810f9602149d35efca16e5edb21e9563280bfbe9721acf0860a5c7a2602632a0f7056ca5cd7b207e9e4c7582da9f5c

data/app/controllers/linked_rails/bulk_controller.rb

@@ -21,8 +21,11 @@ module LinkedRails
       return response_for_wrong_host(opts) if wrong_host?(opts[:iri])
 
       include = opts[:include].to_s == 'true'
+      resource = LinkedRails.iri_mapper.resource_from_iri(request_path_to_url(opts[:iri]), user_context)
 
-      response_from_request(include, RDF::URI(opts[:iri]))
+      return response_from_request(include, RDF::URI(opts[:iri])) if resource.blank?
+
+      response_from_resource(include, opts[:iri], resource)
     rescue StandardError => e
       handle_resource_error(opts, e)
     end
@@ -84,6 +87,13 @@ module LinkedRails
       false
     end
 
+    def resource_cache_control(cacheable, status, resource_policy)
+      return :private unless status == 200 && cacheable
+      return 'no-cache' unless resource_policy.try(:public_resource?)
+
+      :public
+    end
+
     def resource_params(param)
       params = param.permit(:include, :iri)
       params[:iri] = URI(params[:iri])
@@ -131,6 +141,12 @@ module LinkedRails
       }.merge(opts)
     end
 
+    def resource_status(resource_policy)
+      raise(LinkedRails::Errors::Forbidden.new(query: :show?)) unless resource_policy.show?
+
+      200
+    end
+
     def response_for_wrong_host(opts)
       iri = opts[:iri]
       term = term_from_vocab(iri)
@@ -139,6 +155,23 @@ module LinkedRails
       ontology_term_response(iri, term, opts[:include])
     end
 
+    def response_from_resource(include, iri, resource)
+      resource_policy = policy(resource)
+      status = resource_status(resource_policy)
+
+      resource_response(
+        iri,
+        body: response_from_resource_body(include, iri, resource, status),
+        cache: resource_cache_control(resource.try(:cacheable?), status, resource_policy),
+        language: I18n.locale,
+        status: status
+      )
+    end
+
+    def response_from_resource_body(include, _iri, resource, status)
+      include && status == 200 ? resource_body(resource) : nil
+    end
+
     def term_from_vocab(iri)
       vocab = Vocab.for(iri)
       tag = iri.to_s.split(vocab.to_s).last

data/app/models/linked_rails/form.rb

@@ -5,6 +5,7 @@ require 'pundit'
 module LinkedRails
   class Form # rubocop:disable Metrics/ClassLength
     include LinkedRails::Model
+    include LinkedRails::Model::Cacheable
 
     class_attribute :abstract_form, :pages, :model_class
 

data/app/models/linked_rails/manifest.rb

@@ -5,15 +5,11 @@ module LinkedRails
     include ActiveModel::Model
     include LinkedRails::Model
 
-    MANIFEST_KEY = 'cache:Manifest'
-    CACHE_DB = ENV.fetch('PERSISTENT_REDIS_DATABASE', '6')
-
     def save
-      self.class.redis_client.hset(
-        MANIFEST_KEY,
-        {
-          LinkedRails.iri.to_s => web_manifest.to_json
-        }
+      Storage.hset(
+        :persistent,
+        :manifest,
+        LinkedRails.iri.to_s => web_manifest.to_json
       )
     end
 
@@ -165,19 +161,21 @@ module LinkedRails
 
     class << self
       def destroy(iri)
-        redis_client.hdel(MANIFEST_KEY, iri)
+        Storage.hdel(:persistent, :manifest, iri)
       end
 
       def move(from, to)
-        data = redis_client.hget(MANIFEST_KEY, from)
+        Storage.hset(
+          :persistent,
+          :redirect_prefix,
+          from => to
+        )
 
-        redis_client.hset(MANIFEST_KEY, to, data) if data
+        data = Storage.hget(:persistent, :manifest, from)
 
-        destroy(from)
-      end
+        Storage.hset(:persistent, :manifest, to, data) if data
 
-      def redis_client
-        @redis_client = Redis.new(db: CACHE_DB)
+        destroy(from)
       end
     end
   end

data/app/models/linked_rails/menus/list.rb

@@ -26,7 +26,7 @@ module LinkedRails
       end
 
       def menus
-        @menus ||= available_menus.map(&method(:memoised_menu_item))
+        @menus ||= available_menus.map(&method(:memoized_menu_item))
       end
 
       def menu(tag)

data/app/models/linked_rails/ontology.rb

@@ -4,6 +4,7 @@ module LinkedRails
   class Ontology
     include ActiveModel::Model
     include LinkedRails::Model
+    include LinkedRails::Model::Cacheable
 
     def classes
       @classes ||= LinkedRails.linked_models.map do |klass|

data/app/policies/linked_rails/form_policy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class FormPolicy < LinkedRails.policy_parent_class
+    def show?
+      true
+    end
+
+    def public_resource?
+      true
+    end
+  end
+end

data/app/policies/linked_rails/ontology_policy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class OntologyPolicy < LinkedRails.policy_parent_class
+    def show?
+      true
+    end
+
+    def public_resource?
+      true
+    end
+  end
+end

data/app/workers/linked_rails/invalidation_stream_worker.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  class InvalidationStreamWorker < ActiveJob::Base
+    def perform(type, iri, resource_type)
+      entry = {
+        type: type,
+        resource: iri,
+        resourceType: resource_type
+      }
+      id = Storage.xadd(:stream, LinkedRails.cache_stream, entry)
+
+      raise('No message id returned, implies failure') if id.blank?
+    end
+  end
+end

data/lib/generators/linked_rails/install/templates/locales.yml

@@ -11,6 +11,8 @@ en:
       update:
         label: "Edit"
         success: 'Updated successfully'
+  errors:
+    access_denied: "You're not authorized for this action. (%{action})"
   linked_rails:
     status:
       400: "Error in request"

data/lib/linked_rails/controller/error_handling.rb

@@ -6,6 +6,10 @@ module LinkedRails
       extend ActiveSupport::Concern
       include ActiveSupport::Rescuable
 
+      included do
+        rescue_from LinkedRails::Errors::Forbidden, with: :handle_error
+      end
+
       private
 
       def add_error_snackbar(error)
@@ -69,6 +73,7 @@ module LinkedRails
             'Doorkeeper::Errors::InvalidGrantReuse' => 422,
             'LinkedRails::Auth::Errors::Expired' => 410,
             'LinkedRails::Auth::Errors::Unauthorized' => 401,
+            'LinkedRails::Errors::Forbidden' => 403,
             'Pundit::NotAuthorizedError' => 403
           }
         end

data/lib/linked_rails/errors/forbidden.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module Errors
+    class Forbidden < StandardError
+      attr_reader :query, :record, :policy, :action
+
+      # @param [Hash] options
+      # @option options [String] query The action of the request
+      # @option options [ActiveRecord::Base] record The record that was requested
+      # @option options [Policy] policy The policy that raised the exception
+      # @option options [String] message Override the default error message
+      # @return [String] the message
+      def initialize(**options)
+        @query  = options.fetch(:query).to_s
+        @record = options[:record]
+        @policy = options[:policy]
+        @action = @query[-1] == '?' ? @query[0..-2] : @query
+        @message = options[:message]
+
+        raise StandardError if @query.blank? && @message.blank?
+
+        super(@message || default_message)
+      end
+
+      private
+
+      def default_message
+        I18n.t(
+          "pundit.#{@policy.class.to_s.underscore}.#{@query}",
+          action: @action,
+          default: I18n.t('errors.access_denied')
+        )
+      end
+    end
+  end
+end

data/lib/linked_rails/errors.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'errors/forbidden'

data/lib/linked_rails/helpers/resource_helper.rb

@@ -46,6 +46,13 @@ module LinkedRails
 
       private
 
+      def request_path_to_url(path)
+        return path unless path.present? && URI(path).relative?
+
+        port = [80, 443].include?(request.port) ? nil : request.port
+        URI::Generic.new(request.scheme, nil, request.host, port, nil, path, nil, nil, nil).to_s
+      end
+
       def build_new_resource
         controller_class.build_new(user_context: user_context)
       end

data/lib/linked_rails/model/cacheable.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module LinkedRails
+  module Model
+    module Cacheable
+      extend ActiveSupport::Concern
+
+      included do
+        if respond_to?(:after_commit)
+          after_commit :publish_create, on: :create, if: :should_publish_changes
+          after_commit :publish_update, on: :update, if: :should_publish_changes
+          after_commit :publish_delete, on: :destroy, if: :should_publish_changes
+        end
+      end
+
+      def cacheable?
+        true
+      end
+
+      def publish_create
+        publish_message('io.ontola.transactions.Created')
+      end
+
+      def publish_update
+        publish_message('io.ontola.transactions.Updated')
+      end
+
+      def publish_delete
+        publish_message('io.ontola.transactions.Deleted')
+      end
+
+      private
+
+      def publish_message(type)
+        LinkedRails::InvalidationStreamWorker.perform_now(type, iri.to_s, self.class.iri.to_s)
+      rescue StandardError
+        LinkedRails::InvalidationStreamWorker.perform_later(type, iri.to_s, self.class.iri.to_s)
+      end
+
+      def should_publish_changes
+        cacheable? && !Rails.env.test?
+      end
+    end
+  end
+end

data/lib/linked_rails/model.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'model/actionable'
+require_relative 'model/cacheable'
 require_relative 'model/collections'
 require_relative 'model/dirty'
 require_relative 'model/enhancements'

data/lib/linked_rails/policy.rb

@@ -46,6 +46,10 @@ module LinkedRails
       self.class.policy_class
     end
 
+    def public_resource?
+      false
+    end
+
     def show?
       false
     end

data/lib/linked_rails/storage.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+module LinkedRails
+  class Storage
+    REDIS_DB = {
+      cache: LinkedRails.cache_redis_database,
+      persistent: LinkedRails.persistent_redis_database,
+      stream: LinkedRails.stream_redis_database
+    }.freeze
+    KEYS = {
+      manifest: 'cache:Manifest',
+      redirect_exact: 'cache:Redirect:Exact',
+      redirect_prefix: 'cache:Redirect:Prefix'
+    }.freeze
+
+    class << self
+      %i[xadd].each do |method|
+        define_method(method) do |db, *args|
+          Redis.new(db: REDIS_DB.fetch(db)).send(method, *args)
+        end
+      end
+
+      %i[hset hdel hget].each do |method|
+        define_method(method) do |db, key, *args|
+          Redis.new(db: REDIS_DB.fetch(db)).send(method, KEYS.fetch(key), *args)
+        end
+      end
+    end
+  end
+end

data/lib/linked_rails.rb

@@ -22,6 +22,10 @@ module LinkedRails
 
   mattr_accessor :whitelisted_spi_ips
   mattr_writer :host, :scheme
+  mattr_accessor :persistent_redis_database, default: ENV['PERSISTENT_REDIS_DATABASE'].presence || 6
+  mattr_accessor :stream_redis_database, default: ENV['STREAM_REDIS_DATABASE'].presence || 7
+  mattr_accessor :cache_redis_database, default: ENV['CACHE_REDIS_DATABASE'].presence || 8
+  mattr_accessor :cache_stream, default: ENV['CACHE_STREAM'].presence || 'transactions'
 
   def self.configurable_class(parent, klass, default: nil, reader: nil) # rubocop:disable Metrics/AbcSize
     method = :"#{[parent, klass.to_s.downcase].compact.join('_')}_class"
@@ -84,6 +88,7 @@ ActiveSupport::Inflector.inflections do |inflect|
   inflect.acronym 'SHACL'
 end
 
+require 'linked_rails/errors'
 require 'linked_rails/uri_template'
 require 'linked_rails/vocab'
 require 'linked_rails/cache'
@@ -101,3 +106,4 @@ require 'linked_rails/routes'
 require 'linked_rails/serializer'
 require 'linked_rails/translate'
 require 'linked_rails/railtie'
+require 'linked_rails/storage'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linked_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4.pre.g14b377f91
+  version: 0.0.4.pre.g72bb595fe
 platform: ruby
 authors:
 - Arthur Dingemans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_response
@@ -299,8 +299,10 @@ files:
 - app/policies/linked_rails/collection/view_policy.rb
 - app/policies/linked_rails/collection_policy.rb
 - app/policies/linked_rails/enum_value_policy.rb
+- app/policies/linked_rails/form_policy.rb
 - app/policies/linked_rails/menus/item_policy.rb
 - app/policies/linked_rails/menus/list_policy.rb
+- app/policies/linked_rails/ontology_policy.rb
 - app/policies/linked_rails/sequence_policy.rb
 - app/serializers/linked_rails/actions/item_serializer.rb
 - app/serializers/linked_rails/actions/object_serializer.rb
@@ -338,6 +340,7 @@ files:
 - app/serializers/linked_rails/web_page_serializer.rb
 - app/serializers/linked_rails/web_site_serializer.rb
 - app/serializers/linked_rails/widget_serializer.rb
+- app/workers/linked_rails/invalidation_stream_worker.rb
 - config/initializers/inflections.rb
 - lib/generators/linked_rails/install/install_generator.rb
 - lib/generators/linked_rails/install/templates/README
@@ -387,6 +390,8 @@ files:
 - lib/linked_rails/enhancements/destroyable/controller.rb
 - lib/linked_rails/enhancements/updatable/controller.rb
 - lib/linked_rails/enhancements/updatable/serializer.rb
+- lib/linked_rails/errors.rb
+- lib/linked_rails/errors/forbidden.rb
 - lib/linked_rails/helpers/delta_helper.rb
 - lib/linked_rails/helpers/ontola_actions_helper.rb
 - lib/linked_rails/helpers/resource_helper.rb
@@ -395,6 +400,7 @@ files:
 - lib/linked_rails/middleware/linked_data_params.rb
 - lib/linked_rails/model.rb
 - lib/linked_rails/model/actionable.rb
+- lib/linked_rails/model/cacheable.rb
 - lib/linked_rails/model/collections.rb
 - lib/linked_rails/model/dirty.rb
 - lib/linked_rails/model/enhancements.rb
@@ -418,6 +424,7 @@ files:
 - lib/linked_rails/serializer/actionable.rb
 - lib/linked_rails/serializer/menuable.rb
 - lib/linked_rails/serializer/singularable.rb
+- lib/linked_rails/storage.rb
 - lib/linked_rails/test_methods.rb
 - lib/linked_rails/translate.rb
 - lib/linked_rails/types/iri_type.rb