scrivito_sdk 0.18.1 → 0.30.0.rc1

data/lib/scrivito/cms_dispatch_controller.rb

@@ -40,6 +40,13 @@ module Scrivito
 
     def default_controller
       CmsController
+    rescue NameError => e
+      if e.message.include?('CmsController')
+        raise 'Your application does not define the "CmsController" needed for Scrivito. '\
+          'Did you forget to run "rails generate scrivito:install"?'
+      else
+        raise
+      end
     end
   end
 

data/lib/scrivito/cms_env.rb

@@ -57,7 +57,5 @@ module Scrivito
       permalink =  Array(permalink_param).join("/")
       Obj.find_by_permalink!(permalink)
     end
-
   end
-
 end

data/lib/scrivito/cms_field_tag.rb

@@ -2,41 +2,25 @@ module Scrivito
 
 # this class is the server-side equivalent of the JavaScript class `cms_field_element`
 class CmsFieldTag < Struct.new(
-    :view_context, :editing_context, :obj_or_widget, :field_name
-  )
+    :view, :tag_name, :obj_or_widget, :field_name)
 
-  def options
-    formatted_options = {}
-    raw_options.each do |key, value|
-      formatted_options["data-scrivito-#{key}"] = value
-    end
-
-    formatted_options
-  end
-
-  def field_type
-    @field_type ||= obj_or_widget.type_of_attribute(field_name)
-  end
-
-  def default_content
-    calculate_content_and_modification
-    @content_and_modification.first
-  end
+  include TagRenderer
 
-  def modification_info
-    calculate_content_and_modification
-    @content_and_modification.second
-  end
-
-  private
-
-  def calculate_content_and_modification
-    @content_and_modification ||=
-      comparison.diff_for(obj_or_widget, field_name) || [current_value, nil]
+  def content(&block)
+    if field_type == 'widget'
+      raise ArgumentError, 'No block allowed for widget fields' if block_given?
+      modifications = modification_info || []
+      rendered_widgets = default_content.each_with_index.map do |widget, index|
+        WidgetTag.new(view, widget, modifications[index]).render
+      end
+      view.safe_join(rendered_widgets)
+    else
+      block_given? ? view.capture { yield } : view.scrivito_value(default_content)
+    end
   end
 
-  def raw_options
-    return {} unless inplace_editing_allowed?
+  def options
+    return {} unless authenticated_editor?
 
     options = {
       'private-field-workspace-id' => current_workspace_id,
@@ -51,14 +35,14 @@ class CmsFieldTag < Struct.new(
     end
 
     if obj_or_widget.kind_of?(BasicWidget)
-      options['private-field-id'] = obj_or_widget.obj.id
+      options['private-field-obj-id'] = obj_or_widget.obj.id
       options['private-field-widget-id'] = obj_or_widget.id
     else
-      options['private-field-id'] = obj_or_widget.id
+      options['private-field-obj-id'] = obj_or_widget.id
     end
 
     if FIELD_TYPES_WITH_ORIGINAL_CONTENT.include?(field_type)
-      original_value = view_context.display_value(current_value)
+      original_value = view.scrivito_value(current_value)
       original_content = original_content(field_type, original_value)
       encoded_content = Base64.strict_encode64(MultiJson.encode(original_content))
       options['private-field-original-content'] = encoded_content
@@ -74,6 +58,27 @@ class CmsFieldTag < Struct.new(
     options
   end
 
+  def modification_info
+    calculate_content_and_modification
+    @content_and_modification.second
+  end
+
+  private
+
+  def field_type
+    @field_type ||= obj_or_widget.type_of_attribute(field_name)
+  end
+
+  def default_content
+    calculate_content_and_modification
+    @content_and_modification.first
+  end
+
+  def calculate_content_and_modification
+    @content_and_modification ||=
+      comparison.diff_for(obj_or_widget, field_name) || [current_value, nil]
+  end
+
   def comparison
     editing_context.comparison
   end
@@ -96,10 +101,14 @@ class CmsFieldTag < Struct.new(
     text
   ]
 
-  def inplace_editing_allowed?
+  def authenticated_editor?
     editing_context.authenticated_editor?
   end
 
+  def editing_context
+    EditingContextMiddleware.from_request(view.request)
+  end
+
   def original_content(field_type, field_value)
     case field_type
     when 'reference' then field_value.try(:id)

data/lib/scrivito/cms_rest_api.rb

@@ -1,6 +1,3 @@
-require 'restclient'
-require 'active_support/all'
-
 module Scrivito
 
   # Provides a simple wrapper for the CMS Rest API.
@@ -64,6 +61,23 @@ module Scrivito
       @number_of_requests
     end
 
+    def self.upload_file(file)
+      upload_permission = get('blobs/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))
+        else
+          raise ScrivitoError, "File upload failed with code #{response.code}"
+        end
+      end
+    end
+
     class << self
 
       private
@@ -109,10 +123,12 @@ module Scrivito
           raise AccessDenied.new(response.body)
         else
           begin
-            specific_output = MultiJson.decode(response.body)['error']
+            error_body = MultiJson.decode(response.body)
+            specific_output = error_body['error']
 
             if response.code.start_with?('4')
-              raise ClientError.new(specific_output, code)
+              error_code = error_body['code']
+              raise ClientError.new(specific_output, code, error_code)
             elsif response.code == '500' && specific_output
               raise BackendError.new(specific_output, code)
             else # 3xx and >500 are treated as NetworkErrors
@@ -135,7 +151,8 @@ module Scrivito
         end
         return task_data["result"] if task_data["status"] == "success"
         message = task_data["message"] || "Missing error message in task response #{task_data}"
-        raise ClientError.new(message, 400)
+        error_code = task_data['code']
+        raise ClientError.new(message, 400, error_code)
       end
 
       def set_headers(request)

data/lib/scrivito/cms_rest_api/attribute_serializer.rb

@@ -40,7 +40,7 @@ module Scrivito
               elsif value.is_a?(Array)
                 value.map(&:to_s)
               elsif value.is_a?(File)
-                Scrivito::CmsRestApi::BlobUploader.upload_file(value)
+                Scrivito::CmsRestApi.upload_file(value)
               else
                 value.to_s
               end

data/lib/scrivito/cms_routing.rb

@@ -0,0 +1,120 @@
+module Scrivito
+
+class CmsRouting < Struct.new(:request, :main_app)
+  LINK_TO_EMPTY_LINKLIST = "#__empty_linklist"
+  LINK_TO_EMPTY_BLOB = "#__empty_blob"
+
+  def self.match_protocol(url, request)
+    request.ssl? && !url.starts_with?('https') ? url.gsub(/^http/, 'https') : url
+  end
+
+  def path_or_url(target, path_or_url, options = {})
+    if cms_with_editing_context?(target)
+      path_or_url_with_editing_context(target, path_or_url, options)
+    else
+      path_or_url_without_editing_context(target, path_or_url, options)
+    end
+  end
+
+  def convert_links(html)
+    if html
+      html.gsub(%r{<?\bobjid:([a-f0-9]{16})\b>?}) do
+        if obj = Obj.find_by_id($1)
+          path_or_url(obj, "path")
+        else
+          "#__target_object_not_reachable"
+        end
+      end
+    end
+  end
+
+  private
+
+  def path_or_url_with_editing_context(target, path_or_url, options)
+    path_or_url_without_editing_context(target, path_or_url,
+        options.merge(editing_context.to_params))
+  end
+
+  def path_or_url_without_editing_context(target, path_or_url, options)
+    if target.is_a?(Link)
+      path_or_url_for_links(target, path_or_url, options)
+    elsif target.is_a?(Obj)
+      path_or_url_for_objs(target, path_or_url, options)
+    elsif target.respond_to?(:first)
+      if target.first.is_a?(Link)
+        path_or_url_for_links(target.first, path_or_url, options)
+      else
+        return LINK_TO_EMPTY_LINKLIST
+      end
+    else
+      raise "scrivito_path or scrivito_url was called with an instance of #{target.class}. "+
+        "It must only be called with an Obj or a Link or a non-empty LinkList."
+    end
+  end
+
+  def path_or_url_for_links(link, path_or_url, options = {})
+    url = basic_url_or_path_for_link(link, path_or_url,
+        Rack::Utils.parse_nested_query(link.query).merge(options))
+    url = url + "##{link.fragment}" if link.fragment.present?
+    url
+  end
+
+  def path_or_url_for_objs(obj, path_or_url, options = {})
+    permalink = obj.permalink
+    if permalink
+      main_app.public_send("scrivito_permalink_#{path_or_url}", options.merge(:permalink => permalink))
+    elsif obj.homepage?
+      main_app.public_send("scrivito_root_#{path_or_url}", options)
+    else
+      if obj.binary? && editing_context.display_mode != "editing"
+        if obj.binary_url
+          self.class.match_protocol(obj.binary_url, request)
+        else
+          LINK_TO_EMPTY_BLOB
+        end
+      else
+        main_app.public_send(
+          "cms_id_#{path_or_url}",
+          options.merge(
+            id: obj.id,
+            slug: obj.slug.presence
+          )
+        )
+      end
+    end
+  end
+
+  def editor_authenticated?
+    editing_context.authenticated_editor?
+  end
+
+  def editing_context
+    EditingContextMiddleware.from_request(request)
+  end
+
+  def cms_with_editing_context?(target)
+    editor_authenticated? && (!target.is_a?(Link) || target.internal?)
+  end
+
+  def basic_url_or_path_for_link(link, path_or_url, options = {})
+    if link.internal?
+      path_or_url_without_editing_context(link.obj, path_or_url, options)
+    else
+      url = link.url
+      url = merge_options(url, options) if options.any?
+      url
+    end
+  end
+
+  def merge_options(url, options)
+    parsed_url = URI.parse(url)
+
+    query = Rack::Utils.parse_query(parsed_url.query)
+    merged_query = query.merge(options.stringify_keys)
+    parsed_url.query = merged_query.to_query
+
+    parsed_url.to_s
+  end
+end
+
+end

data/lib/scrivito/configuration.rb

@@ -1,21 +1,4 @@
-require 'scrivito/blob'
-
 module Scrivito
-  #
-  # Configures the Scrivito SDK.
-  # The configuration keys +tenant+ and +api_key+ _must_ be provided.
-  #
-  # @example
-  #   Scrivito.configure do |config|
-  #     config.tenant  = 'my-tenant-name'
-  #     config.api_key = 'secret'
-  #   end
-  #
-  # @api public
-  #
-  def self.configure
-    yield ::Scrivito::Configuration
-  end
 
   #
   # @api public
@@ -30,28 +13,46 @@ module Scrivito
 
     class << self
       # Determine if current visitor is permitted to edit content.
-      attr_accessor :editing_auth_callback
-
       attr_accessor :find_user_proc
 
-      # Configure a callback to be invoked when the Scrivito SDK determines,
-      # if current visitor is permitted to edit content.
-      # Default is <code>false</code>.
       #
-      # Example Usage:
-      #     Scrivito::Configuration.editing_auth do |env|
-      #       request = Rack::Request.new(env)
-      #       # return truey if current visitor is permitted to edit content, falsy otherwise
-      #     end
+      # Configures a callback to be invoked when the SDK determines whether current visitor is
+      # permitted to edit content.
+      #
+      # If the callback is missing in the +development+ or +test+ environment, then the SDK will
+      # assume, that the current visitor is {Scrivito::User.system_user}, who can always create
+      # workspaces, can always read, write, publish, delete and invite to any workspace.
+      #
+      # If the callback is missing in any other environment (for example in +production+ or
+      # +staging+), then the SDK will assume, that the current visitor is not permitted to edit
+      # content.
+      #
       # @api public
+      #
+      # @param [Proc] block proc for detemining if the current visitor is permitted to edit content
+      # @yieldparam [Hash] env rack env
+      # @yieldreturn [Scrivito::User] if the current visitor is permitted to edit content
+      # @yieldreturn [false, nil] if the current visitor is not permitted to edit content
+      #
+      # @example
+      #   Scrivito::Configuration.editing_auth do |env|
+      #     if user_id = env['USER_ID']
+      #       Scrivito::User.define(user_id)
+      #     end
+      #   end
+      #
       def editing_auth(&block)
         if block.respond_to?(:arity) && block.arity == 1
-          self.editing_auth_callback = block
+          @editing_auth_callback = block
         else
           raise ArgumentError, 'editing_auth should have only one attribute!'
         end
       end
 
+      def editing_auth_callback
+        @editing_auth_callback || default_editing_auth_callback
+      end
+
       # Configures how to find users for the in-place GUI.
       # @api public
       # @param [Proc] find_user_proc proc for finding a user by the user id
@@ -80,11 +81,6 @@ module Scrivito
         self.find_user_proc = find_user_proc
       end
 
-      # TODO: Legacy compatiblity. Remove when DisplayHelper gets removed.
-      def editor_interface_enabled?
-        false
-      end
-
       # The +Scrivito+ makes heavy use of filesystem caching.
       # Use this method to configure the directory that should be used to store cached data.
       # By default, +RAILS_ROOT/tmp/scrivito_cache+ will be used.
@@ -148,25 +144,23 @@ module Scrivito
           NamedLink.reset_cache
           BasicObj.reset_type_computer!
           BasicWidget.reset_type_computer!
-          ::ApplicationController.__send__(:helper, :cms)
         end
       end
 
-      def configure_cms_database
-      end
-
       def tenant
-        assert_key_present(:tenant)
-        @tenant
+        tenant = @tenant || ENV['SCRIVITO_TENANT']
+        assert_configuration_key_present(:tenant, tenant)
+        tenant
       end
 
       def api_key
-        assert_key_present(:api_key)
-        @api_key
+        api_key = @api_key || ENV['SCRIVITO_API_KEY']
+        assert_configuration_key_present(:api_key, api_key)
+        api_key
       end
 
       def endpoint
-        assert_key_present(:endpoint)
+        raise 'Missing required configuration key "endpoint"' unless @endpoint
         @endpoint
       end
 
@@ -176,7 +170,6 @@ module Scrivito
 
       def set_defaults!
         self.ca_file = DEFAULT_CA_FILE
-        self.editing_auth { |env| false }
         self.endpoint = 'api.scrivito.com'
         self.check_batch_size = 100
       end
@@ -192,18 +185,6 @@ module Scrivito
         self.choose_homepage_callback = block
       end
 
-      def cms_routes(*args)
-        raise <<-EOS.gsub(/\s+/, ' ')
-        Calling Scrivito::Configuration.cms_routes is not needed anymore.
-        Please remove it from config/routes.rb
-        EOS
-      end
-
-      def use_x_sendfile=(value)
-        raise 'Configuration.use_x_sendfile is now available as Rails configuration:'\
-              ' config.action_dispatch.x_sendfile_header = "X-Sendfile"'
-      end
-
       def obj_formats
         @obj_formats ||= {
           '_default' => proc do |obj, user|
@@ -229,11 +210,41 @@ module Scrivito
         end
       end
 
+      # For test purposes only.
+      def reset_editing_auth_callback!
+        @editing_auth_callback = nil
+      end
+
+      def migration_path
+        'scrivito/migrate'
+      end
+
       private
 
-      def assert_key_present(key)
-        if instance_variable_get("@#{key}").nil?
-          raise "Missing required configuration key '#{key}'."
+      def default_editing_auth_callback
+        if Rails.env.development? || Rails.env.test?
+          ->(_) { User.system_user }
+        end
+      end
+
+      def assert_configuration_key_present(key, value)
+        unless value
+          raise %{
+            Missing the required configuration key "#{key}".
+
+            You need to configure the "tenant" and the "api_key" in order to connect the application
+            to the Scrivito backend.
+
+            Either use the environment variables "SCRIVITO_TENANT" and "SCRIVITO_API_KEY" or set the
+            keys in an initializer:
+
+              Scrivito.configure do |config|
+                config.tenant  = 'my_tenant'
+                config.api_key = 'secret123'
+              end
+
+            The values of the keys can be obtained from the dashboard at https://scrivito.com.
+          }
         end
       end