scrivito_sdk 1.17.0.rc2 → 1.18.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 146486584acb9660d1f7ceb8d7ecbe072bdb0b3e2ea9fab5437db0d66ded97a7
-  data.tar.gz: d8d757425944ffd948c56e5513c1e01a91092a205aaec407143ae302b31350e6
+  metadata.gz: 856c448a586b8d9fa46e5646c6f7032ea565d7655241986324b69ad307047d74
+  data.tar.gz: 1d340bc1501d4aa4377e6ab3e58897a5d44ce309400126cd31c007f111f67d16
 SHA512:
-  metadata.gz: ded66fee7754e12b25d6ebbaed8063190990c3e0c218f44d3e8386cd81a7a98ed9885002eaaf21ba880237d06efc9e2ddd8d655164c6cb73dd61b3df4a5ca60e
-  data.tar.gz: 9ee6a548c78305663fac85d0b407a77bbac3eb2879bca4ef0afebd7d6604b9c3e2eed34fd400055f92a56a199004c96f891ac6af001d7f7c0af599e11141e2fc
+  metadata.gz: bb162b76792cda107d884e95d014c709bd01900983333e7210b13adbd7dd9aff754327ef462d70fd8344e3be9a8cf676dcf97930306f6ff0fc0561103229c3b7
+  data.tar.gz: 470df0ee44eb1237666078fd0c8b2d5891966183233097662ec8d8219895862a41c892e5fb561f18abde1423bb00ed3993606dbe196fe53121b75b1cce180ab2

data/README.md

@@ -12,7 +12,7 @@ of concepts and APIs, tutorials, and release notes.
 
 ## License
 
-Copyright (c) 2009 - 2020 Infopark Group GmbH (http://www.infopark.com)
+Copyright (c) 2009 - 2021 JustRelate Group GmbH (https://www.justrelate.com)
 
 This software can be used and modified under the LGPL-3.0. Please refer to
 http://www.gnu.org/licenses/lgpl-3.0.html for the license text.

data/app/cms/scrivito/application_error.rb

@@ -0,0 +1,13 @@
+module Scrivito
+
+class ApplicationError < ScrivitoError
+  def http_code
+    412
+  end
+
+  def as_json
+    {message: message, message_for_editor: message}
+  end
+end
+
+end # module Scrivito

data/app/cms/scrivito/backend/base_index.rb

@@ -0,0 +1,49 @@
+module Scrivito
+module Backend
+
+# Abstract Base for Index Implementations
+module BaseIndex
+  def id
+    abstract_base_method
+  end
+
+  def update(key, cached_result, change_index)
+    updated = Set.new(cached_result)
+
+    change_index.each do |id, data|
+      value = extract_update_value_from_data(data)
+
+      if value == key
+        updated.add(id)
+      else
+        updated.delete(id)
+      end
+    end
+
+    updated.to_a
+  end
+
+  def extract_update_value_from_data(data)
+    abstract_base_method
+  end
+
+  def group_by(keys, obj_datas)
+    return [obj_datas] if keys.length == 1
+
+    group_by_multiple(keys, obj_datas)
+  end
+
+  def group_by_multiple(parent_paths, obj_datas)
+    abstract_base_method
+  end
+
+  private
+
+  def abstract_base_method
+    raise Scrivito::InternalError, "not implemented"
+  end
+
+end
+
+end
+end

data/app/cms/scrivito/backend/index.rb

@@ -1,7 +1,6 @@
 module Scrivito
 module Backend
 
-# Abstract Base for Index Implementations
 module Index
 
   IMPLEMENTATIONS = [
@@ -19,46 +18,6 @@ module Index
       raise Scrivito::InternalError, "unknown index #{name}"
   end
 
-  def id
-    abstract_base_method
-  end
-
-  def update(key, cached_result, change_index)
-    updated = Set.new(cached_result)
-
-    change_index.each do |id, data|
-      value = extract_update_value_from_data(data)
-
-      if value == key
-        updated.add(id)
-      else
-        updated.delete(id)
-      end
-    end
-
-    updated.to_a
-  end
-
-  def extract_update_value_from_data(data)
-    abstract_base_method
-  end
-
-  def group_by(keys, obj_datas)
-    return [obj_datas] if keys.length == 1
-
-    group_by_multiple(keys, obj_datas)
-  end
-
-  def group_by_multiple(parent_paths, obj_datas)
-    abstract_base_method
-  end
-
-  private
-
-  def abstract_base_method
-    raise Scrivito::InternalError, "not implemented"
-  end
-
 end
 
 end

data/app/cms/scrivito/backend/parent_path_index.rb

@@ -2,7 +2,7 @@ module Scrivito
 module Backend
 
 module ParentPathIndex
-  extend Backend::Index
+  extend Backend::BaseIndex
 
   def self.id
     "ppath"

data/app/cms/scrivito/backend/path_index.rb

@@ -2,7 +2,7 @@ module Scrivito
 module Backend
 
 module PathIndex
-  extend Backend::Index
+  extend Backend::BaseIndex
 
   def self.id
     "path"

data/app/cms/scrivito/backend/permalink_index.rb

@@ -2,7 +2,7 @@ module Scrivito
 module Backend
 
 module PermalinkIndex
-  extend Backend::Index
+  extend Backend::BaseIndex
 
   def self.id
     "permalink"

data/app/cms/scrivito/basic_obj.rb

@@ -719,10 +719,13 @@ module Scrivito
       }
     end
 
+    # @note If the custom attribute +created_at+ is defined, this value will be returned
+    #   instead of the system attribute +_created_at+. To access the system attribute
+    #   regardless of a custom attribute, call {#[] <code>obj[:_created_at]</code>}.
     # @return [nil, ActiveSupport::TimeWithZone]
     # @api public
     def created_at
-      read_attribute('_created_at')
+      read_custom_or_system_attribute('created_at')
     end
 
     # @return [ActiveSupport::TimeWithZone]
@@ -731,16 +734,22 @@ module Scrivito
       read_attribute('_last_changed')
     end
 
+    # @note If the custom attribute +first_published_at+ is defined, this value will be returned
+    #   instead of the system attribute +_first_published_at+. To access the system attribute
+    #   regardless of a custom attribute, call {#[] <code>obj[:_first_published_at]</code>}.
     # @return [nil, ActiveSupport::TimeWithZone]
     # @api public
     def first_published_at
-      read_attribute('_first_published_at')
+      read_custom_or_system_attribute('first_published_at')
     end
 
+    # @note If the custom attribute +published_at+ is defined, this value will be returned
+    #   instead of the system attribute +_published_at+. To access the system attribute
+    #   regardless of a custom attribute, call {#[] <code>obj[:_published_at]</code>}.
     # @return [nil, ActiveSupport::TimeWithZone]
     # @api public
     def published_at
-      read_attribute('_published_at')
+      read_custom_or_system_attribute('published_at')
     end
 
     def new?(revision=workspace.base_revision)
@@ -1072,6 +1081,12 @@ module Scrivito
 
     private
 
+    def read_custom_or_system_attribute(attribute_name)
+      return read_attribute(attribute_name) if has_custom_attribute?(attribute_name)
+
+      read_attribute("_#{attribute_name}")
+    end
+
     def children_including_deleted
       workspace.objs.find_by_parent_path_including_deleted(path)
     end

data/app/cms/scrivito/cms_rest_api.rb

@@ -136,21 +136,26 @@ module Scrivito
     end
 
     private_class_method def self.handle_response(resource_path, response)
-      http_code = response.code.to_i
       if response.code.start_with?('2')
         JSON.parse(response.body)
       elsif response.code == '403'
         raise AccessDenied.new(response.body)
       else
+        http_code = response.code.to_i
         begin
-          error_body = JSON.parse(response.body)
+          error_body =
+            if http_code == 404 && response.body == "Not Found"
+              {'error' => response.body}
+            else
+              JSON.parse(response.body)
+            end
           specific_output = error_body['error']
 
           if response.code.start_with?('4')
             backend_code = error_body['code']
             raise ClientError.new(specific_output,
                 http_code: http_code, backend_code: backend_code)
-          elsif response.code == '500' && specific_output
+          elsif http_code == 500 && specific_output
             raise BackendError.new(specific_output, http_code)
           else # 3xx and >500 are treated as NetworkErrors
             raise NetworkError.new(response.body, http_code)

data/app/cms/scrivito/controller_actions.rb

@@ -164,7 +164,7 @@ module ControllerActions
   def deliver_file
     if binary = @obj.binary
       binary_routing = BinaryRouting.new(request, scrivito_engine)
-      redirect_to binary_routing.resolved_binary_url(binary)
+      redirect_to binary_routing.resolved_binary_url(binary), allow_other_host: true
     else
       render plain: 'Empty Blob', status: 404
     end

data/app/cms/scrivito/generator_helper.rb

@@ -1,10 +1,12 @@
 module Scrivito
 module GeneratorHelper
   def self.attribute_definition(arg)
-    if %w(enum multienum).include?(arg.type.to_s)
-      "attribute :#{arg.name}, :#{arg.type}, values: []"
+    name, type = arg.to_s.split(":")
+
+    if %w(enum multienum).include?(type)
+      "attribute :#{name}, :#{type}, values: []"
     else
-      "attribute :#{arg.name}, :#{arg.type}"
+      "attribute :#{name}, :#{type}"
     end
   end
 end

data/app/cms/scrivito/internal_error.rb

@@ -0,0 +1,8 @@
+module Scrivito
+
+# this error is raised if scrivito detects an internal problem.
+# these errors should never occur when using the public api of the SDK.
+class InternalError < ScrivitoError
+end
+
+end # module Scrivito

data/app/cms/scrivito/layout_tags.rb

@@ -17,7 +17,7 @@ class LayoutTags < Struct.new(:view)
   end
 
   def generator_meta_tag
-    content = 'Scrivito by Infopark Group GmbH (scrivito.com)'
+    content = 'Scrivito by JustRelate Group GmbH (scrivito.com)'
     content << "; Version #{GemInfo.version}" if view.scrivito_user
     view.tag(:meta, name: 'generator', content: content)
   end

data/app/cms/scrivito/model_library.rb

@@ -114,7 +114,7 @@ class ModelLibrary
         Dir["#{path}/**/*.rb"].sort.each do |file_path|
           begin
             require_dependency(file_path)
-          rescue TypeError => e
+          rescue TypeError, Zeitwerk::NameError => e
             raise e if file_path.starts_with?(Rails.root.to_s)
           end
         end

data/app/cms/scrivito/obj_class_not_found.rb

@@ -0,0 +1,7 @@
+module Scrivito
+
+# @api public
+class ObjClassNotFound < ResourceNotFound
+end
+
+end # module Scrivito

data/app/cms/scrivito/resource_not_found.rb

@@ -0,0 +1,14 @@
+module Scrivito
+
+# @api public
+class ResourceNotFound < ScrivitoError
+  def http_code
+    404
+  end
+
+  def as_json
+    {message: message}
+  end
+end
+
+end # module Scrivito

data/app/cms/scrivito/scrivito_error.rb

@@ -0,0 +1,7 @@
+module Scrivito
+
+# @api public
+class ScrivitoError < StandardError
+end
+
+end # module Scrivito

data/app/cms/scrivito/sdk_engine.rb

@@ -1,10 +1,10 @@
 require 'rails'
+require 'sprockets/railtie'
 
 require 'jbuilder'
 require 'jquery-rails'
 require 'net/http/post/multipart'
 require 'json'
-require_relative './errors'
 
 module ::Scrivito
   class SdkEngine < Rails::Engine

data/app/cms/scrivito/transformation_definition_error.rb

@@ -0,0 +1,7 @@
+module Scrivito
+
+# @api public
+class TransformationDefinitionError < TransformationError
+end
+
+end # module Scrivito

data/app/cms/scrivito/transformation_error.rb

@@ -0,0 +1,13 @@
+module Scrivito
+
+# @api public
+class TransformationError < ScrivitoError
+  attr_reader :code
+
+  def initialize(message, code)
+    @code = code
+    super(message)
+  end
+end
+
+end # module Scrivito

data/app/cms/scrivito/transformation_source_error.rb

@@ -0,0 +1,7 @@
+module Scrivito
+
+# @api public
+class TransformationSourceError < TransformationError
+end
+
+end # module Scrivito

data/app/controllers/scrivito/binary_redirect_controller.rb

@@ -2,7 +2,7 @@ module Scrivito
   class BinaryRedirectController < ActionController::Base
     def to_binary
       binary = BinaryParamVerifier.verify(params[:encrypted_params])
-      redirect_to BinaryRewrite.call(request, binary.url), status: 301
+      redirect_to BinaryRewrite.call(request, binary.url), status: 301, allow_other_host: true
     rescue BinaryParamVerifier::InvalidSignature
       head :precondition_failed
     rescue TransformationSourceError => error
@@ -15,7 +15,7 @@ module Scrivito
     private
 
     def render_error(error_name)
-      redirect_to view_context.image_path("scrivito/#{error_name}.png")
+      redirect_to view_context.image_path("scrivito/#{error_name}.png"), allow_other_host: true
     end
   end
 end

data/app/controllers/scrivito/ui_controller.rb

@@ -15,7 +15,7 @@ class UiController < ActionController::Base
         lookup_context: lookup_context,
       })
 
-      render 'scrivito/ui/index.html'
+      render 'scrivito/ui/index', formats: [:html]
     else
       redirect_to @application_src
     end