scrivito_sdk 0.70.2 → 0.71.0.rc1

data/lib/scrivito/basic_widget.rb

@@ -228,11 +228,14 @@ class BasicWidget
       previous_obj_content =
           CmsRestApi.get("revisions/#{workspace.base_revision_id}/objs/#{obj.id}")
       previous_widget_content = previous_obj_content["_widget_pool"]["#{id}"]
+      previous_widget_content = self.class.reset_blank_attributes(previous_widget_content)
+
       previous_widget_content.delete_if do |attribute_name, _|
         type_of_attribute(attribute_name) == 'widgetlist'
       end
       CmsRestApi.put("workspaces/#{workspace.id}/objs/#{obj.id}",
           { obj: {_widget_pool: {id => previous_widget_content}} })
+      reload
     else
       raise ScrivitoError, "cannot revert changes, since widget is #{modification}."
     end
@@ -243,17 +246,17 @@ class BasicWidget
     obj_in_revision && obj_in_revision.widget_from_pool(id)
   end
 
-  def new?(revision=Workspace.current.base_revision)
+  def new?(revision=workspace.base_revision)
     return false unless revision
     obj.new?(revision) || cms_data_for_revision(revision).nil?
   end
 
-  def deleted?(revision=Workspace.current.base_revision)
+  def deleted?(revision=workspace.base_revision)
     return false unless revision
     obj.deleted?(revision)
   end
 
-  def modification(revision=Workspace.current.base_revision)
+  def modification(revision=workspace.base_revision)
     return Modification::UNMODIFIED unless revision
 
     if deleted?(revision)
@@ -329,14 +332,16 @@ class BasicWidget
 
   def forget_unsaved_attributes
     @attributes_to_be_saved = nil
-    reload
+    reload_data
   end
 
   def reload
     obj.reload
+    reload_data
+  end
 
-    update_proc = -> { obj.widget_data_from_pool(id) }
-    update_data(update_proc)
+  def reload_data
+    update_data -> { obj.widget_data_from_pool(id) }
   end
 
   # @api public

data/lib/scrivito/binary.rb

@@ -6,13 +6,56 @@ module Scrivito
 class Binary
   attr_reader :id, :transformation_definition
 
-  def initialize(id, is_public, transformation_definition = nil, original = nil)
+  def initialize(id, is_public, transformation_definition: nil, original: nil)
     @id = id
     @is_public = !!is_public
     @transformation_definition = transformation_definition
     @original = original
   end
 
+  # @api public
+  # Uploads a local file to the CMS.
+  # @example Upload a single file
+  #   @obj.update(blob: Scrivito::Binary.upload("/Desktop/kitten.jpg"))
+  #
+  #   # equivalent to
+  #   @obj.update(blob: File.new("/Desktop/kitten.jpg"))
+  # @example Upload a file with a different filename and content type
+  #   @obj.update(blob: Scrivito::Binary.upload(
+  #       "/Desktop/rick_astley", content_type: "Video/MP4", filename: "ufo_landing.m4v"))
+  # @param file_or_path [File, String] the file to be uploaded or
+  #   the path of the file to be uploaded.
+  # @param filename [String, Nil] the desired filename. If +nil+,
+  #   the name of the given file is used.
+  # @param content_type [String, Nil] the desired content type. If +nil+,
+  #   the content type is calculated based on the extension of the filename.
+  # @return [Scrivito::FutureBinary] the returned object should be inserted into the binary field
+  #   of an {Scrivito::BasicObj Obj} or {Scrivito::BasicWidget Widget}.
+  def self.upload(file_or_path, filename: nil, content_type: nil)
+    if file_or_path.is_a?(File)
+      file = file_or_path
+    else
+      file = File.new(file_or_path)
+    end
+    new_filename = filename || File.basename(file_or_path)
+    FutureBinary.new(content_type: content_type, filename: new_filename, file_to_be_uploaded: file)
+  end
+
+  # @api public
+  # Create a copy of this Binary with a different filename and/or content type.
+  # @example Change filename and content_type of an existing binary. Binary content remains the same.
+  #   @obj.update(blob: @obj.blob.copy(filename: "cute_kitten.jpg", content_type: "video/mp4"))
+  # @param filename [String, Nil] the desired filename. If +nil+,
+  #   the filename of the original binary is used.
+  # @param content_type [String, Nil] the desired content type. If +nil+,
+  #   the content type is calculated based on the extension of the filename.
+  # @return [Scrivito::FutureBinary] the returned object should be inserted into the binary field
+  #   of an Obj or Widget.
+  def copy(content_type: nil, filename: nil)
+    new_filename = filename || self.filename
+    FutureBinary.new(content_type: content_type, filename: new_filename, id_to_be_copied: id)
+  end
+
   # @api public
   # Some Scrivito data is considered private, i.e. it is not currently intended
   # for the general public, for example content in a workspace that has not
@@ -131,8 +174,8 @@ class Binary
   #
   #   If the given width and height are adjusted, the aspect ratio is preserved.
   #
-  # @option definition [Symbol,String] :fit Controls how the tranformed image is fitted to the
-  #   given width and heigth. Valid values are +:clip+ and +:crop+. The default value is +:clip+.
+  # @option definition [Symbol,String] :fit Controls how the transformed image is fitted to the
+  #   given width and height. Valid values are +:clip+ and +:crop+. The default value is +:clip+.
   #
   #   If set to +:clip+, the image is resized so as to fit within the width and height boundaries
   #   without cropping or distorting the image. The resulting image is assured to match one of the
@@ -163,7 +206,9 @@ class Binary
   # @see ScrivitoHelper#scrivito_image_tag
   #
   def transform(definition)
-    self.class.new(id, public?, (transformation_definition || {}).merge(definition), original)
+    self.class.new(id, public?,
+      transformation_definition: (transformation_definition || {}).merge(definition),
+      original: original)
   end
 
   #
@@ -232,7 +277,7 @@ class Binary
     deserialized_meta_data = {}
     raw_meta_data.each_pair do |key, (type, value)|
       deserialized_meta_data[key] = case type
-                                    when 'date' then DateAttribute.deserialize_from_backend(value)
+                                    when 'date' then DateAttribute.parse(value)
                                     when 'number' then value.to_i
                                     else value
                                     end

data/lib/scrivito/binary_param_verifier.rb

@@ -6,18 +6,17 @@ module BinaryParamVerifier
   class << self
     def verify(params)
       params = message_verifier.verify(params)
-      expires = DateAttribute.deserialize_from_backend(params['expires'])
+      expires = DateAttribute.parse(params['expires'])
       raise InvalidSignature if expires && expires < Time.zone.now
-      Binary.new(params['binary_id'], expires.nil?, params['transformation_definition'])
+      Binary.new(params['binary_id'], expires.nil?,
+          transformation_definition: params['transformation_definition'])
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       raise InvalidSignature
     end
 
     def generate(binary)
       params = {binary_id: binary.id, transformation_definition: binary.transformation_definition}
-      if binary.private?
-        params[:expires] = DateAttribute.serialize_for_backend(Time.zone.now + 1.hour)
-      end
+      params[:expires] = DateAttribute.serialize(Time.zone.now + 1.hour) if binary.private?
       message_verifier.generate(params)
     end
 

data/lib/scrivito/client_attribute_serializer.rb

@@ -19,7 +19,7 @@ module ClientAttributeSerializer
   def self.serialize_system_attrs(obj)
     {
       '_id'        => obj.id,
-      '_obj_class' => obj.obj_class_name,
+      '_obj_class' => obj.obj_class,
       '_path'      => obj.path,
       '_permalink' => obj.permalink,
     }
@@ -71,7 +71,7 @@ module ClientAttributeSerializer
   end
 
   def self.serialize_date_value(value)
-    DateAttribute.serialize_for_client(value)
+    value.utc.iso8601
   end
 
   def self.serialize_enum_value(value)
@@ -126,7 +126,7 @@ module ClientAttributeSerializer
 
   def self.serialize_widget(widget)
     {
-      '_obj_class' => widget.obj_class_name
+      '_obj_class' => widget.obj_class
     }.merge(serialize_custom_attrs(widget))
   end
 end

data/lib/scrivito/cms_backend.rb

@@ -250,8 +250,20 @@ module Scrivito
       end
     end
 
+    def create_obj(workspace_id, attributes)
+      write_obj(:post, "/workspaces/#{workspace_id}/objs", attributes)
+    end
+
+    def update_obj(workspace_id, obj_id, attributes)
+      write_obj(:put, "/workspaces/#{workspace_id}/objs/#{obj_id}", attributes)
+    end
+
     private
 
+    def write_obj(verb, path, attributes)
+      Backend::ObjDataFromRest.new(CmsRestApi.task_unaware_request(verb, path, attributes))
+    end
+
     def update_workspace_cache(id, cached_data_tag, changed_workspace, options)
       if changed_workspace
         workspace_data = changed_workspace

data/lib/scrivito/cms_field_tag.rb

@@ -21,7 +21,8 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
       raise ArgumentError, 'No block allowed for widgetlist fields' if block_given?
       modifications = modification_info || []
       rendered_widgets = default_content.each_with_index.map do |widget, index|
-        WidgetTag.new(view, widget, modifications[index], widget_template_name, inner_tag).render
+        WidgetTag.new(view, widget, placement_modification: modifications[index],
+          render_context: widget_render_context, inner_tag: inner_tag).render
       end
       view.safe_join(rendered_widgets)
     else
@@ -33,10 +34,11 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
     return {} unless authenticated_editor?
 
     options = {
-      'private-field-workspace-id' => current_workspace_id,
       'field-name'                 => field_name,
-      'field-obj-class'            => obj_or_widget.obj_class_name,
+      'field-obj-class'            => obj_or_widget.obj_class,
       'field-type'                 => field_type,
+      'private-editor'             => editing_options[:editor],
+      'private-field-workspace-id' => current_workspace_id,
     }
 
     modification = comparison.modification_for_attribute(obj_or_widget, field_name)
@@ -61,7 +63,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
     if field_type == 'widgetlist'
       options["private-field-widget-inner-tag"] = inner_tag
       options['private-field-widget-allowed-classes'] = build_valid_widget_classes.to_json
-      options['private-field-widget-template'] = widget_template_name
+      options['private-field-widget-template'] = widget_render_context
     end
 
     options
@@ -84,8 +86,8 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_option
     end
   end
 
-  def widget_template_name
-    editing_options[:widget_template_name]
+  def widget_render_context
+    editing_options[:widget_render_context] || WidgetTag::DEFAULT_RENDER_CONTEXT
   end
 
   def field_name

data/lib/scrivito/cms_rest_api.rb

@@ -53,7 +53,9 @@ module Scrivito
 
     def self.task_unaware_request(method, resource_path, payload = nil)
       raise "Unexpected method #{method}" unless [:delete, :get, :post, :put].include?(method)
-      response_for_request_cms_api(method, resource_path, payload, build_timer)
+      log_api_request(method, resource_path, payload) do
+        response_for_request_cms_api(method, resource_path, payload, build_timer)
+      end
     end
 
     def self.count_requests(path)
@@ -64,10 +66,23 @@ module Scrivito
       @number_of_requests
     end
 
-    def self.upload_file(file, obj_id)
-      upload_permission = get('blobs/upload_permission')
-      upload = perform_file_upload(file, upload_permission)
-      activate_upload(upload: upload, obj_id: obj_id)
+    def self.upload_future_binary(binary, obj_id)
+      if binary.id_to_be_copied
+        {
+          content_type: binary.content_type,
+          filename: binary.filename,
+          id: binary.id_to_be_copied,
+        }
+      else
+        upload_permission = get('blobs/upload_permission')
+        upload = perform_file_upload(
+          file: binary.file_to_be_uploaded,
+          filename: binary.filename,
+          content_type: binary.content_type,
+          upload_permission: upload_permission,
+        )
+        activate_upload(upload: upload, obj_id: obj_id)
+      end
     end
 
     def self.activate_upload(params)
@@ -84,6 +99,8 @@ module Scrivito
       private
 
       def request_cms_api(action, resource_path, payload, options)
+        assert_valid_resource_path(resource_path)
+
         log_api_request(action, resource_path, payload) do
           @number_of_requests += 1 if resource_path == @count_requests
 
@@ -171,16 +188,15 @@ module Scrivito
         end
       end
 
-      def perform_file_upload(file, upload_permission)
+      def perform_file_upload(file:, filename:, content_type:, upload_permission:)
         uri = URI.parse(upload_permission['url'])
         File.open(file) do |open_file|
-          content_type = MIME::Types.type_for(file.path).first.content_type
           upload_io = UploadIO.new(open_file, content_type, File.basename(file))
           params = upload_permission['fields'].merge('file' => upload_io)
           request = Net::HTTP::Post::Multipart.new(uri.path, params)
           response = ConnectionManager.request(uri, request)
           if response.code.starts_with?('2')
-            upload_permission['blob'].merge('filename' => File.basename(file.path))
+            upload_permission['blob'].merge('filename' => filename, 'content_type' => content_type)
           else
             raise ScrivitoError, "File upload failed with code #{response.code}"
           end
@@ -231,6 +247,10 @@ module Scrivito
       def method_to_net_http_class(method)
         METHOD_TO_NET_HTTP_CLASS.fetch(method)
       end
+
+      def assert_valid_resource_path(resource_path)
+        URI(resource_path)
+      end
     end
   end
 end

data/lib/scrivito/cms_rest_api/rate_limit.rb

@@ -15,6 +15,7 @@ module RateLimit
         time_to_sleep = calculate_time_to_sleep(response['Retry-After'].to_f, retry_count)
 
         if request_timer.cover?(Time.now + time_to_sleep.seconds)
+          Warning.warn("Rate limit exceeded. Will retry after #{time_to_sleep} seconds.")
           sleep time_to_sleep
           internal_retry(request_proc, request_timer, retry_count + 1)
         else

data/lib/scrivito/cms_routing.rb

@@ -98,7 +98,13 @@ class CmsRouting < Struct.new(:request, :main_app, :scrivito_engine, :image_opti
       "cms_id_#{path_or_url}"
     end
 
-    main_app.public_send(method_name, options.merge(id: obj.id))
+    options[:id] = obj.id
+
+    # Options must have the key slug.
+    # Otherwise Rails will use the slug from current request params.
+    options[:slug] ||= nil
+
+    main_app.public_send(method_name, options)
   end
 
   def homepage?(obj)

data/lib/scrivito/configuration.rb

@@ -273,7 +273,7 @@ module Scrivito
           '_default' => proc do |obj, user|
             {
               id: obj.id,
-              obj_class_name: obj.obj_class_name,
+              obj_class: obj.obj_class,
               description_for_editor: obj.description_for_editor,
               modification: obj.modification,
               has_conflict: obj.has_conflict?,

data/lib/scrivito/controller_actions.rb

@@ -40,64 +40,67 @@ module ControllerActions
 
   def show_widget
     widget = load_widget
-    widget_tag = Scrivito::WidgetTag.new(view_context, widget, nil,
-                                         params[:template_name], params[:inner_tag])
+    widget_tag = Scrivito::WidgetTag.new(view_context, widget,
+      render_context: params[:template_name], inner_tag: params[:inner_tag])
     render text: widget_tag.render, layout: false
   end
 
   def widget_details
     assert_dialog_layout
     widget = load_widget
-    template_path = "#{widget.obj_class_name.underscore}/details"
-    @scrivito_default_widget_template = :details
-    render template_path, layout: 'scrivito_dialog', locals: {widget: widget}
+    @scrivito_widget_render_context = :details
+    render widget.details_view_path, layout: 'scrivito_dialog', locals: {widget: widget}
   end
 
   def page_details
     assert_dialog_layout
-    @scrivito_default_widget_template = :details
+    @scrivito_widget_render_context = :details
     render @obj.details_view_path, layout: 'scrivito_dialog'
   rescue ActionView::MissingTemplate
     render 'scrivito/page_details', layout: 'scrivito_dialog'
   end
 
-  # How to handle widget errors in +production+.
+  # @!method on_scrivito_widget_error(widget, error)
+  #   How to handle widget errors in +production+.
   #
-  # When an exception is raised from within a widget, the entire page is not available.
-  # Often, this is the case in production if the developer has forgotten to handle specific
-  # content scenarios such as empty date attributes, missing titles, unmanaged enum values, etc.
-  # but also for simple coding mistakes during development.
+  #   When an exception is raised from within a widget, the entire page is not available.
+  #   Often, this is the case in production if the developer has forgotten to handle specific
+  #   content scenarios such as empty date attributes, missing titles, unmanaged enum values, etc.
+  #   but also for simple coding mistakes during development.
   #
-  # Override this method to prevent the entire page from being unavailable due to widget errors.
+  #   By default, Scrivito handles exceptions raised while rendering a widget by adding a
+  #   placeholder text to the HTML indicating that the widget couldn't be rendered. In addition,
+  #   the exception is logged alongside with its backtrace.
   #
-  # The overridden method allows to:
-  # * catch a widget error and replace it with an HTML placeholder.
-  # * report a widget error to an external service like Honeybadger or Airbrake.
+  #   Override this method to adapt this behaviour.
   #
-  # This method is _not_ called if Rails is in the +development+ or +test+ environment.
-  # In those environments, all widget errors are just raised.
+  #   The overridden method allows to:
+  #   * catch a widget error and replace it with an HTML placeholder.
+  #   * report a widget error to an external service like Honeybadger or Airbrake.
   #
-  # By default, this method just reraises the given error.
+  #   This method is _not_ called if Rails is in the +development+ or +test+ environment.
+  #   In those environments, all widget errors are just raised.
   #
-  # @param widget [Scrivito::BasicWidget] the flawed widget
-  # @param error [StandardError] the error that occurred
-  # @raise [StandardError] if this method is not overridden, the +error+ passed to it is reraised.
+  #   @param widget [Scrivito::BasicWidget] the flawed widget
+  #   @param error [StandardError] the error that occurred
+  #   @raise [StandardError] if this method is not overridden, the +error+ passed to it 
+  #     is reraised.
   #
-  # @example Notify external service about widget error and render an HTML placeholder:
-  #   def on_scrivito_widget_error(widget, error)
-  #     # Report error to external service (e.g. Honeybadger or Airbrake):
-  #     Honeybadger.notify(error)
-  #     notify_airbrake(error)
+  #   @example Notify external service about widget error and render an HTML placeholder:
+  #     def on_scrivito_widget_error(widget, error)
+  #       # Report error to external service (e.g. Honeybadger or Airbrake):
+  #       Honeybadger.notify(error)
+  #       notify_airbrake(error)
   #
-  #     # Replace corrupted widget output with a placeholder:
-  #     message = "Rendering #{widget.description_for_editor} failed with #{error.message}"
-  #     return "<!--#{message}-->".html_safe if Rails.env.production?
-  #     "<p>#{message}</p>".html_safe
-  #   end
-  # @api public
-  def on_scrivito_widget_error(widget, error)
-    raise error
-  end
+  #       # Replace corrupted widget output with a placeholder:
+  #       message = "Rendering #{widget.description_for_editor} failed with #{error.message}"
+  #       return "<!--#{message}-->".html_safe if Rails.env.production?
+  #       "<p>#{message}</p>".html_safe
+  #     end
+  #
+  #   @api public
+
+  # This empty line is necessary for yard to function correctly
 
   module ClassMethods
     #