scrivito_sdk 0.17.0 → 0.18.0

data/lib/scrivito/cms_backend.rb

@@ -123,8 +123,62 @@ module Scrivito
       end
     end
 
+    def search_objs(workspace, params)
+      content_state = workspace.revision.content_state
+      cache_index = 'search'
+      cache_key = params.to_param
+
+      if result = fetch_search_result_from_cache(content_state, cache_index, cache_key)
+        result
+      else
+        request_search_result_from_backend(workspace, params).tap do |result|
+          store_search_result_in_cache(content_state, cache_index, cache_key, result)
+        end
+      end
+    end
+
+    def find_obj_class_data_by_name(revision, name)
+      find_all_obj_class_data(revision).find { |obj_class_data| obj_class_data.name == name }
+    end
+
+    def find_all_obj_class_data(revision)
+      content_state = revision.content_state
+      if obj_classes_data = fetch_obj_classes_data_from_cache(content_state)
+        obj_classes_data
+      else
+        request_obj_classes_data_from_backend(revision).tap do |obj_classes_data|
+          store_obj_classes_data_in_cache(content_state, obj_classes_data)
+        end
+      end
+    end
+
     private
 
+    def fetch_obj_classes_data_from_cache(content_state)
+      ContentStateCaching.find_obj_classes_data(content_state) if caching?
+    end
+
+    def request_obj_classes_data_from_backend(revision)
+      response = CmsRestApi.get("revisions/#{revision.id}/obj_classes", include_inactive: true)
+      response['results'].map { |raw_data| ObjClassData.new(raw_data) }
+    end
+
+    def store_obj_classes_data_in_cache(content_state, obj_classes_data)
+      ContentStateCaching.store_obj_classes_data(content_state, obj_classes_data) if caching?
+    end
+
+    def fetch_search_result_from_cache(content_state, cache_index, cache_key)
+      content_state.find_obj_data(cache_index, cache_key) if caching?
+    end
+
+    def request_search_result_from_backend(workspace, params)
+      CmsRestApi.get("workspaces/#{workspace.id}/objs/search", params)
+    end
+
+    def store_search_result_in_cache(content_state, cache_index, cache_key, result)
+      content_state.save_obj_data(cache_index, cache_key, result) if caching?
+    end
+
     def find_obj_data_filtering_deleted_by(revision, index, keys, include_deleted)
       index = index.to_s
       assert_valid_index_name(index)

data/lib/scrivito/cms_cache_storage.rb

@@ -45,6 +45,14 @@ module CmsCacheStorage
     def write_obj_data(content_state_id, index, key, data)
       cache.write("content/#{content_state_id}/obj/#{index}/#{key}", data)
     end
+
+    def read_obj_classes_data(content_state_id)
+      cache.read("content/#{content_state_id}/obj_classes")
+    end
+
+    def write_obj_classes_data(content_state_id, data)
+      cache.write("content/#{content_state_id}/obj_classes", data)
+    end
   end
 end
 

data/lib/scrivito/cms_field_tag.rb

@@ -60,7 +60,8 @@ class CmsFieldTag < Struct.new(
     if FIELD_TYPES_WITH_ORIGINAL_CONTENT.include?(field_type)
       original_value = view_context.display_value(current_value)
       original_content = original_content(field_type, original_value)
-      options['private-field-original-content'] = MultiJson.encode(original_content)
+      encoded_content = Base64.strict_encode64(MultiJson.encode(original_content))
+      options['private-field-original-content'] = encoded_content
     end
 
     if field_type == 'widget'

data/lib/scrivito/cms_rest_api.rb

@@ -56,11 +56,20 @@ module Scrivito
       response_for_request_cms_api(method, resource_path, payload)
     end
 
+    def self.count_requests(path)
+      @count_requests = path
+      @number_of_requests = 0
+      yield
+      @count_requests = nil
+      @number_of_requests
+    end
+
     class << self
 
       private
 
       def request_cms_api(action, resource_path, payload, options)
+        @number_of_requests += 1 if resource_path == @count_requests
         decoded = response_for_request_cms_api(action, resource_path, payload)
         return decoded unless Hash === decoded
         return decoded unless decoded.keys == ["task"]

data/lib/scrivito/configuration.rb

@@ -178,9 +178,10 @@ module Scrivito
         self.ca_file = DEFAULT_CA_FILE
         self.editing_auth { |env| false }
         self.endpoint = 'api.scrivito.com'
+        self.check_batch_size = 100
       end
 
-      attr_accessor :choose_homepage_callback, :activate_users_and_permissions
+      attr_accessor :choose_homepage_callback, :check_batch_size
 
       # Configure a callback to be invoked when the Scrivito SDK delivers the homepage.
       # The given callback will receive the rack env
@@ -205,7 +206,7 @@ module Scrivito
 
       def obj_formats
         @obj_formats ||= {
-          '_default' => proc do |obj|
+          '_default' => proc do |obj, user|
             {
               id: obj.id,
               obj_class_name: obj.obj_class_name,
@@ -214,6 +215,7 @@ module Scrivito
               has_conflict: obj.has_conflict?,
               last_changed: obj.last_changed.utc.iso8601,
               is_binary: obj.binary?,
+              restriction_messages: user.restriction_messages_for(obj)
             }
           end
         }

data/lib/scrivito/content_state.rb

@@ -48,6 +48,14 @@ class ContentState < Struct.new(:content_state_id, :changes, :changes_index, :fr
     CmsCacheStorage.read_obj_data(content_state_id, index, key)
   end
 
+  def save_obj_classes_data(data)
+    CmsCacheStorage.write_obj_classes_data(content_state_id, data)
+  end
+
+  def find_obj_classes_data
+    CmsCacheStorage.read_obj_classes_data(content_state_id)
+  end
+
   # Fetches and caches the ancestor.
   # Returns nil if there is no ancestor.
   def from_content_state

data/lib/scrivito/content_state_caching.rb

@@ -38,6 +38,26 @@ module ContentStateCaching
         nil
       end
     end
+
+    def store_obj_classes_data(content_state, data)
+      content_state.save_obj_classes_data(data)
+    end
+
+    def find_obj_classes_data(current_content_state)
+      visitor = ContentStateVisitor.new(current_content_state)
+
+      cache_lookup_depth.times do |depth|
+        return unless content_state = visitor.visit_next
+        if obj_classes_data = content_state.find_obj_classes_data
+          if depth >= cache_replication_depth
+            current_content_state.save_obj_classes_data(obj_classes_data)
+          end
+          return obj_classes_data
+        end
+      end
+
+      nil
+    end
   end
 
   self.cache_replication_depth = 5

data/lib/scrivito/editing_context.rb

@@ -18,15 +18,11 @@ class EditingContext
       @editor = @editor_callback.call
 
       if @editor && !@editor.is_a?(Scrivito::User)
-        if Scrivito::Configuration.activate_users_and_permissions
-          raise ScrivitoError.new(
-            "The editing auth callback has to return a Scrivito::User or falsy."+
-            " To upgrade please return Scrivito::User.new(id) and set the permissions" +
-            " of the user. See the documentation for further details."
+        raise ScrivitoError.new(
+          "The editing auth callback has to return a Scrivito::User or falsy."+
+          " To upgrade please return Scrivito::User.new(id) and set the permissions" +
+          " of the user. See the documentation for further details."
         )
-        else
-          @editor = User.anonymous_admin
-        end
       end
     end
 
@@ -50,37 +46,13 @@ class EditingContext
   # defaults to "published" if no workspace with `selected_workspace_id` can be found.
   # @return [Workspace]
   def selected_workspace
-    unless @selected_workspace
-      if @selected_workspace_id
-        begin
-          @selected_workspace = Workspace.find(@selected_workspace_id)
-        rescue Scrivito::ResourceNotFound
-          @selected_workspace = Workspace.default
-        end
-      else
-        @selected_workspace = Workspace.default
-      end
-    end
-
-    @selected_workspace
+    @selected_workspace ||= find_selected_workspace
   end
 
   # when authenticated_editor? return selected_workspace, otherwise published workspace.
   # @return [Workspace]
   def visible_workspace
-    unless @visible_workspace
-      if authenticated_editor?
-        if display_mode == 'deleted'
-          @visible_workspace = Workspace.default
-        else
-          @visible_workspace = selected_workspace
-        end
-      else
-        @visible_workspace = Workspace.default
-      end
-    end
-
-    @visible_workspace
+    @visible_workspace ||= find_visible_workspace
   end
 
   def comparison
@@ -102,6 +74,35 @@ class EditingContext
 
   private
 
+  def find_selected_workspace
+    if @selected_workspace_id
+      begin
+        workspace = Workspace.find(@selected_workspace_id)
+        if editor && editor.can?(:read, workspace)
+          workspace
+        else
+          default_workspace
+        end
+      rescue Scrivito::ResourceNotFound
+        default_workspace
+      end
+    else
+      default_workspace
+    end
+  end
+
+  def find_visible_workspace
+    if authenticated_editor?
+      display_mode == 'deleted' ? default_workspace : selected_workspace
+    else
+      default_workspace
+    end
+  end
+
+  def default_workspace
+    Workspace.default
+  end
+
   # @return [Revision] or +nil+
   def compare_revision
     case display_mode

data/lib/scrivito/membership.rb

@@ -1,16 +1,16 @@
 module Scrivito
 
-  # @api beta
+  # @api public
   # Represents a Membership of a {User} in a {Workspace}
   class Membership
 
-    # @api beta
+    # @api public
     # The {User User's} id
     #
     # @return [String]
     attr_reader :user_id
 
-    # @api beta
+    # @api public
     # The role associated with this membership.
     #
     # @note Currently the only available role is "owner".
@@ -22,5 +22,24 @@ module Scrivito
       @user_id = user_id
       @role = data.fetch("role")
     end
+
+    # Fetches and returns the {User} with the id {Membership#user_id}.
+    # Uses the proc set in {Configuration.find_user} to fetch the user.
+    # @api public
+    # @return The value returned by the proc set in {Configuration.find_user}.
+    # @return An unknown user if no proc is set in {Configuration.find_user} or the proc returns a
+    #     falsy value. The unknown user will have the id of the original user and no abilities.
+    # @see Scrivito::Configuration.find_user
+    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/memberships_collection.rb

@@ -1,5 +1,5 @@
 module Scrivito
-  # @api beta
+  # @api public
   # The MembershipsCollection includes all members of a given {Workspace}.
   # You can access it using {Workspace#memberships} method.
   class MembershipsCollection
@@ -8,7 +8,7 @@ module Scrivito
 
     attr_reader :workspace
 
-    # @api beta
+    # @api public
     # @!method each
     # Iterate over all {Membership Memberships} of a specfic {Workspace}. Allows
     # you to use all methods defined by ruby's Enumerable module.
@@ -39,7 +39,7 @@ module Scrivito
       @workspace = workspace
     end
 
-    # @api beta
+    # @api public
     # return a hash where the keys are user_ids and the values are Membership-Instances
     # @return [Hash<String, Membership>]
     def to_h
@@ -49,7 +49,7 @@ module Scrivito
       end
     end
 
-    # @api beta
+    # @api public
     # Returns the membership for a user or nil
     #
     # @param  [User, String] id_or_user
@@ -64,6 +64,10 @@ module Scrivito
       to_h[id]
     end
 
+    def to_a
+      memberships.sort_by(&:user_id)
+    end
+
     private
 
     def memberships

data/lib/scrivito/obj_class.rb

@@ -17,11 +17,7 @@ module Scrivito
       #
       # @return [Array<Scrivito::ObjClass>]
       def all
-        results = CmsRestApi.get("workspaces/#{Workspace.current.id}/obj_classes")['results']
-
-        results.map do |properties|
-          new(properties)
-        end
+        Workspace.current.obj_classes.to_a
       end
 
       # Finds an obj class by its name.
@@ -35,13 +31,13 @@ module Scrivito
       # @return [Scrivito::ObjClass]
       # @raise [Scrivito::ResourceNotFound] Raised when no obj class with the given +name+ can be found.
       def find(name)
-        response = begin
-          CmsRestApi.get("workspaces/#{Workspace.current.id}/obj_classes/#{name}")
-        rescue Scrivito::ClientError
-          raise ResourceNotFound, "Could not find '#{self}' with name '#{name}'."
+        obj_class = Workspace.current.obj_classes[name]
+
+        unless obj_class
+          raise ResourceNotFound, "Could not find '#{ObjClass}' with name '#{name}'."
         end
 
-        new(response)
+        obj_class
       end
 
       # Creates a new obj class and persists it in the CMS.
@@ -94,21 +90,10 @@ module Scrivito
           end
         end
 
-        params = format_properties_for_cms(properties)
-        obj_class = new(params)
-
-        if properties[:attributes]
-          properties[:attributes].each do |attribute|
-            attribute.obj_class = obj_class
-          end
-        end
-
-        payload = { 'obj_class' => params }
-        response = CmsRestApi.post("workspaces/#{Workspace.current.id}/obj_classes", payload)
-
-        obj_class.update_instance_properties(response)
-
-        obj_class
+        workspace = Workspace.current
+        raw_obj_class_data = workspace.api_request(:post, '/obj_classes',
+            obj_class: format_properties_for_cms(properties))
+        new(ObjClassData.new(raw_obj_class_data), workspace)
       end
 
       private
@@ -124,9 +109,7 @@ module Scrivito
         end
 
         if params.has_key?(:attributes)
-          params[:attributes] = params[:attributes].map do |attribute|
-            attribute.to_cms_rest_api
-          end
+          params[:attributes] = params[:attributes].map(&:to_cms_rest_api)
         end
 
         params
@@ -137,47 +120,34 @@ module Scrivito
     #
     # See {ObjClass.create} for a detailed overview of how to set properties.
     #
-    # @param [Hash] properties
-    # @return [Scrivito::ObjClass]
+    # @param [Hash] obj_class_data
+    # @param [Workspace,NilClass] workspace
     # @raise [Scrivito::ScrivitoError]
-    def initialize(properties)
-      update_instance_properties(properties)
-    end
-
-    # Returns a unique identifier of this obj class. Implements
-    # the {Scrivito::ModelIdentity} interface.
-    # @return [String]
-    def id
-      @name
+    # @return [Scrivito::ObjClass]
+    def initialize(obj_class_data, workspace)
+      update_obj_class_data(obj_class_data)
+      @workspace = workspace
     end
 
-    # Returns the name of this obj class.
-    # @api public
-    # @return [String]
-    def name
-      @name
-    end
+    # @!attribute [r] id
+    #   @api public
+    #   @return [String] unique identifier of this obj class
+    # @!attribute [r] name
+    #   @api public
+    #   @return [String] the name of this obj class
+    # @!attribute [r] is_active
+    #   @api public
+    #   @return [Boolean] whether instances can be created with this obj class
+    # @!attribute [r] is_binary
+    #   @api public
+    #   @return [Boolean] whether instances of this class are binary, e.g. images or PDFs
+    delegate :id, :name, :is_active, :is_binary, to: :obj_class_data
 
-    # Returns if new {Scrivito::BasicObj} instances can be created with this obj class.
-    # @api public
-    # @return [Boolean]
-    def is_active
-      @is_active
-    end
     alias_method :active?, :is_active
-
-    # Returns if new {Scrivito::BasicObj} instances created with this obj class are
-    # binary objects like images or PDF documents.
-    # @api public
-    # @return [Boolean]
-    def is_binary
-      @is_binary
-    end
     alias_method :binary?, :is_binary
 
-    # Returns the attributes for this obj class.
-    #
     # @api public
+    # @return [Scrivito::AttributeCollection] the attributes of this obj class.
     #
     # @example Find an attribute named "locale" for the obj class "Homepage".
     #   ObjClass.find('Homepage').attributes['locale']
@@ -193,11 +163,7 @@ module Scrivito
     #   ObjClass.find('Homepage').attributes.each do |attribute|
     #     puts "#{attribute.name}:#{attribute.type}"
     #   end
-    #
-    # @return [Scrivito::AttributeCollection]
-    def attributes
-      @attributes
-    end
+    attr_reader :attributes
 
     # Updates this obj class and persists the changes in the CMS. It is not possible to
     # update the +name+ or +is_binary+ property.
@@ -227,56 +193,35 @@ module Scrivito
 
       if params.has_key?(:attributes)
         params[:attributes].map! do |attribute|
-          unless attribute.respond_to?(:to_cms_rest_api)
-            attribute = Attribute.new(attribute)
-          end
-
+          attribute = Attribute.new(attribute) unless attribute.respond_to?(:to_cms_rest_api)
           attribute.obj_class = self
           attribute.to_cms_rest_api
         end
       end
 
-      payload = { obj_class: params }
-      response = CmsRestApi.put("workspaces/#{Workspace.current.id}/obj_classes/#{name}", payload)
-
-      update_instance_properties(response)
+      raw_obj_class_data = workspace.api_request(:put, "/obj_classes/#{name}", obj_class: params)
+      update_obj_class_data(ObjClassData.new(raw_obj_class_data))
+      workspace.reload
 
       nil
     end
 
-    # Updates the instance properties of this obj class with +properties+
-    # given in the CMS REST API format.
-    #
-    # @param [Hash] properties
-    # @return [void]
-    def update_instance_properties(properties)
-      properties = properties.with_indifferent_access
-
-      if properties.has_key?(:type)
-        properties[:is_binary] = %w(image generic).include?(properties[:type])
-      end
-
-      @name = properties[:name].to_s
-      @is_active = properties[:is_active]
-      @is_binary = properties[:is_binary]
-      @attributes = create_attribute_collection(properties[:attributes] || [])
+    def update_obj_class_data(obj_class_data)
+      @obj_class_data = obj_class_data
+      update_attributes
     end
 
     private
 
-    # Creates an attribute collection from an Array of attributes given in the CMS REST API format
-    # and binds all attributes to this obj class.
-    #
-    # @param [Array] attributes
-    # @return [Scrivito::AttributeCollection]
-    def create_attribute_collection(attributes)
-      attributes = attributes.map do |properties|
-        attribute = Attribute.new(properties)
+    attr_reader :obj_class_data, :workspace
+
+    def update_attributes
+      attributes = @obj_class_data.attributes.map do |attribute_data|
+        attribute = Attribute.new(attribute_data)
         attribute.obj_class = self
         attribute
       end
-
-      AttributeCollection.new(self, attributes)
+      @attributes = AttributeCollection.new(self, attributes)
     end
   end
 end