scrivito_sdk 0.18.1 → 0.30.0.rc1

data/lib/scrivito/connection_manager.rb

@@ -26,6 +26,35 @@ module Scrivito
       def reset_instance!
         @instance = nil
       end
+
+      def request(uri, request, timeout = nil)
+        instance_for(uri).request(request, timeout)
+      end
+
+      # For test purpose only.
+      def clear_cache!
+        @instances = nil
+      end
+
+      def cert_store
+        @cert_store ||= OpenSSL::X509::Store.new.tap do |store|
+          store.set_default_paths
+          store.add_file(Configuration.ca_file)
+        end
+      end
+
+      private
+
+      def instance_for(uri)
+        endpoint_url = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+        instances.fetch(endpoint_url) do
+          instances[endpoint_url] = new(URI.parse(endpoint_url))
+        end
+      end
+
+      def instances
+        @instances ||= {}
+      end
     end
 
     def initialize(uri)
@@ -56,7 +85,7 @@ module Scrivito
         if uri.scheme == 'https'
           conn.use_ssl = true
           conn.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          conn.ca_file = Scrivito::Configuration.ca_file
+          conn.cert_store = self.class.cert_store
         end
         configure_timeout(conn, timeout)
         retry_twice_on_socket_error do

data/lib/scrivito/content_service.rb

@@ -93,16 +93,19 @@ class ContentService
     end
 
     def handle_response(response)
-      if response.code.first == '2'
-        retry_after = response["Retry-After"]
+      case code = response.code
+      when /^2/
+        retry_after = response['Retry-After']
         @next_request_not_before = retry_after ? Time.now + retry_after.to_f : nil
         MultiJson.load(response.body)
-      elsif response.code == "429"
-        raise RateLimitExceeded.new(response["Retry-After"])
-      elsif response.code == '403'
-        raise AccessDenied.new(response.body)
+      when '429' then raise RateLimitExceeded.new(response['Retry-After'])
+      when '403' then raise AccessDenied.new(response.body)
+      when '401', '404'
+        raise NetworkError.new(
+          'There was a problem communicating with the Scrivito backend. '\
+          'Check your configuration, i.e. "tenant" and "api_key".', code)
       else
-        raise NetworkError.new("Server responded with status code #{response.code}", response.code)
+        raise NetworkError.new("Server responded with status code #{code}", code)
       end
     end
 

data/lib/scrivito/controller_actions.rb

@@ -0,0 +1,108 @@
+module Scrivito
+#
+# This module provides CMS controller actions.
+# Include it in controller you want to make able to deliver +Obj+s.
+#
+# @api public
+#
+# @see Scrivito::TestRequest#for_scrivito_obj
+#
+# @example
+#   class PageCmsController < ApplicationController
+#     include Scrivito::ControllerActions
+#   end
+#
+module ControllerActions
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :require_authenticated_editor, only: [
+      :details_page,
+      :show_widget,
+      :widget_details,
+    ]
+
+    before_filter :load_object
+  end
+
+  #
+  # Default action.
+  # Delivers files directly if +Obj+ is binary.
+  # Otherwise the view is rendered.
+  #
+  # @api public
+  #
+  def index
+    deliver_file if @obj.binary?
+  end
+
+  def show_widget
+    widget = load_widget
+    render text: Scrivito::WidgetTag.new(view_context, widget).render, layout: false
+  end
+
+  def widget_details
+    widget = load_widget
+    template_path = "#{widget.obj_class_name.underscore}/details"
+    render template_path, layout: false, locals: {widget: widget}
+  end
+
+  def details_page
+    @scrivito_resource = editing_context.selected_workspace.objs
+        .find_including_deleted(params[:resource_id])
+    render text: '', layout: true
+  end
+
+  module ClassMethods
+    #
+    # This method indicates if this controller should be used automatically when an +Obj+ is
+    # requested via the SDK's standard routes. It returns +true+ by default.
+    #
+    # Overwrite it to return +false+ if you do want your controller to be excluded from +Obj+
+    # dispatching.
+    #
+    # @api public
+    # @see Obj#controller_name
+    #
+    def use_for_obj_dispatch?
+      true
+    end
+  end
+
+  private
+
+  def require_authenticated_editor
+    head(:forbidden) unless editing_context.authenticated_editor?
+  end
+
+  def editing_context
+    request.env[EditingContextMiddleware::ENVKEY] || EditingContext.new
+  end
+
+  def load_object
+    CmsEnv.new(request.env).load
+    loaded_obj = request.env[CmsEnv::OBJ_ENV_KEY]
+    raise loaded_obj if loaded_obj.is_a?(StandardError)
+    @obj = loaded_obj
+  end
+
+  def load_widget
+    @obj.widget_from_pool(params[:widget_id])
+  end
+
+  #
+  # Deliver a binary +Obj+ by redirecting to its {BasicObj#binary Obj#binary}'s url.
+  # Will respond with 404 if the +Obj+ has no +blob+.
+  #
+  # @api public
+  #
+  def deliver_file
+    if url = @obj.binary_url
+      redirect_to CmsRouting.match_protocol(url, request)
+    else
+      render text: 'Empty Blob', status: 404
+    end
+  end
+end
+
+end

data/lib/scrivito/diff.rb

@@ -25,25 +25,40 @@ class Diff; class << self
   end
 
   def for_html(mode, old, new)
-    return nil if !old
-    return nil if !new
-
-    hyp_diff_options =
-      case mode
-      when "added"
-        {render_deletion: proc {}, markup_from: "after"}
-      when "deleted"
-        {render_insertion: proc {}, markup_from: "before"}
-      when "diff"
-        {}
-      else
-        return nil
-      end
+    return if !old
+    return if !new
+    return unless %w[added deleted diff].include?(mode)
 
-    diff = HypDiff.compare(old, new, hyp_diff_options)
+    diff = HypDiff.compare(old, new, hyp_diff_options(mode))
     [StringTagging.tag_as_html(diff)]
   end
 
+  def hyp_diff_options(mode)
+    render_insertion_proc = proc { |html| "<span class='scrivito_insertion'>#{html}</span>" }
+    render_deletion_proc  = proc { |html| "<span class='scrivito_deletion'>#{html}</span>" }
+    render_nothing_proc   = proc {}
+
+    case mode
+    when 'added'
+      {
+        render_insertion: render_insertion_proc,
+        render_deletion: render_nothing_proc,
+        markup_from: 'after'
+      }
+    when 'deleted'
+      {
+        render_insertion: render_nothing_proc,
+        render_deletion: render_deletion_proc,
+        markup_from: 'before'
+      }
+    when 'diff'
+      {
+        render_insertion: render_insertion_proc,
+        render_deletion: render_deletion_proc
+      }
+    end
+  end
+
   class ListComparison
     def self.for(mode, old, new)
       new(mode).compare(old, new).result

data/lib/scrivito/editing_context.rb

@@ -65,6 +65,10 @@ class EditingContext
       end
   end
 
+  def editable_display_mode?
+    display_mode == 'editing'
+  end
+
   def to_params
     {
       '_scrivito_display_mode' => display_mode,

data/lib/scrivito/editing_context_helper.rb

@@ -0,0 +1,19 @@
+module Scrivito
+
+class EditingContextHelper < Struct.new(:request)
+  def scrivito_user
+    editing_context.editor
+  end
+
+  def in_editable_view?
+    editing_context.editable_display_mode?
+  end
+
+  private
+
+  def editing_context
+    Scrivito::EditingContextMiddleware.from_request(request)
+  end
+end
+
+end

data/lib/scrivito/editing_context_middleware.rb

@@ -5,6 +5,10 @@ module Scrivito
 class EditingContextMiddleware
   ENVKEY = 'SCRIVITO_EDITING_CONTEXT'
 
+  def self.from_request(request)
+    request.env[ENVKEY]
+  end
+
   def initialize(app)
     @app = app
   end
@@ -26,7 +30,7 @@ class EditingContextMiddleware
 
     env[ENVKEY] = EditingContext.new(
       display_mode: display_mode,
-      editor: -> { Configuration.editing_auth_callback.call(env) },
+      editor: editor_proc(env),
       selected_workspace_id: workspace_id
     )
 
@@ -35,6 +39,21 @@ class EditingContextMiddleware
 
   private
 
+  def editor_proc(env)
+    if editing_auth_callback = Configuration.editing_auth_callback
+      -> { editing_auth_callback.call(env) }
+    else
+      Rails.logger.warn(%{
+        WARNING!
+
+        Application is running in "#{Rails.env}" environment, but authentication is not configured.
+        For security reasons the in-place editing is disabled.
+        Please see https://scrivito.com/permissions for details.
+      })
+      nil
+    end
+  end
+
   def parse_url_params(request)
     {
       'display_mode' => request.params['_scrivito_display_mode'],

data/lib/scrivito/image_tag_helper.rb

@@ -0,0 +1,44 @@
+module Scrivito
+
+class ImageTagHelper < Struct.new(:view_context)
+
+  def self.display_title(target)
+    if target.respond_to?(:display_title)
+      return target.display_title
+    elsif target.respond_to?(:first) && target.first.respond_to?(:display_title)
+      return target.first.display_title
+    end
+  end
+
+  def options(obj, field_name, tag_options, editing_options)
+    tag_options.reverse_merge(src: scrivito_image_tag_src(obj, field_name, editing_options),
+        alt: scrivito_image_tag_alt(obj, field_name))
+  end
+
+  private
+
+  def scrivito_image_tag_src(obj, field_name, editing_options)
+    scrivito_image_tag_path(obj, field_name) || editing_options[:placeholder] ||
+        view_context.image_path('scrivito/image_placeholder.png')
+  end
+
+  def scrivito_image_tag_alt(obj, field_name)
+    self.class.display_title(obj[field_name])
+  end
+
+  def scrivito_image_tag_path(obj, field_name)
+    field_type = obj.type_of_attribute(field_name)
+    field_value = obj[field_name]
+
+    case field_type
+    when 'reference' then field_value && view_context.scrivito_path(field_value)
+    when 'link' then field_value && view_context.scrivito_path(field_value)
+    when 'linklist'
+      path = view_context.scrivito_path(field_value)
+      path == CmsRouting::LINK_TO_EMPTY_LINKLIST ? nil : path
+    end
+  end
+
+end
+
+end

data/lib/scrivito/layout_tags.rb

@@ -0,0 +1,33 @@
+module Scrivito
+
+class LayoutTags < Struct.new(:view)
+  def client_config(obj, resource)
+    if view.scrivito_user
+      editing_context = EditingContextMiddleware.from_request(view.request)
+      config = ClientConfig.new(obj, editing_context, view.lookup_context,
+        resource: resource,
+        return_to: view.params[:return_to]
+      ).to_json
+      view.content_tag(:div, '', 'data-scrivito-private-config' => config, style: 'display:none')
+    end
+  end
+
+  def editing_auth_warning
+    view.render('scrivito/editing_auth_warning') unless Configuration.editing_auth_callback
+  end
+
+  def generator_meta_tag
+    content = 'Scrivito by Infopark AG (scrivito.com)'
+    content << "; Version #{GemInfo.version}" if view.scrivito_user
+    view.tag(:meta, name: 'generator', content: content)
+  end
+
+  def reset_stylesheet_tag
+    view.content_tag(:style, %{
+      *[data-scrivito-field-type="widget"],
+      *[data-scrivito-private-widget-id] { position: relative; }
+    }.squish, {type: 'text/css'}, false)
+  end
+end
+
+end

data/lib/scrivito/link.rb

@@ -1,6 +1,8 @@
+require 'active_model/naming'
+
 module Scrivito
   # This class provides an interfaces for handling CMS Links.
-  # To format a link for rendering in an html page, use the +cms_path+ or +cms_url+ methods.
+  # To format a link for rendering in an html page, use the +scrivito_path+ or +scrivito_url+ methods.
   # @api public
   class Link
 
@@ -31,7 +33,7 @@ module Scrivito
 
     # The link's external url. Only available for external links.
     # Warning: Do not output the url directly unless you know what you are doing.
-    # Normally you want to use the +cms_path+ or +cms_url+ methods to format a link.
+    # Normally you want to use the +scrivito_path+ or +scrivito_url+ methods to format a link.
     # @api public
     def url
       @link_data[:url]

data/lib/scrivito/membership.rb

@@ -33,13 +33,5 @@ module Scrivito
     def user
       User.find(user_id) || User.unknown_user(user_id)
     end
-
-    def as_json(options = nil)
-      {
-        user_id: user_id,
-        role: role,
-        description: user.description,
-      }
-    end
   end
 end

data/lib/scrivito/migrations.rb

@@ -5,7 +5,6 @@ module Scrivito
     autoload :Migration
     autoload :Migrator
     autoload :MigrationStore
-    autoload :MigrationDsl
     autoload :CmsBackend
     autoload :WorkspaceLock
   end

data/lib/scrivito/migrations/installer.rb

@@ -38,7 +38,7 @@ module Scrivito
       end
 
       def relative_migration_path
-        'cms/migrate'
+        Scrivito::Configuration.migration_path
       end
     end
   end

data/lib/scrivito/migrations/migration.rb

@@ -13,8 +13,6 @@ module Scrivito
     #     end
     #   end
     class Migration
-      include MigrationDsl
-
       class << self
         def copy(destination, sources)
           unless File.exist?(destination)