scrivito_sdk 0.16.0 → 0.17.0

data/lib/scrivito/cms_field_tag.rb

@@ -58,7 +58,7 @@ class CmsFieldTag < Struct.new(
     end
 
     if FIELD_TYPES_WITH_ORIGINAL_CONTENT.include?(field_type)
-      original_value = view_context.display_original_value(current_value)
+      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)
     end

data/lib/scrivito/cms_rest_api/attribute_serializer.rb

@@ -27,6 +27,8 @@ module Scrivito
                 nil
               elsif link_array?(value)
                 convert_links(value)
+              elsif value.is_a?(Link)
+                convert_link(value)
               elsif value.is_a?(BasicObj)
                 value.id
               elsif widget_array?(value)
@@ -88,10 +90,13 @@ module Scrivito
 
         def convert_links(links)
           links.map do |link|
-            link.to_cms_api_linklist_params
+            convert_link(link)
           end
         end
 
+        def convert_link(link)
+          link.to_cms_api_linklist_params
+        end
       end
     end
   end

data/lib/scrivito/cms_rest_api/blob_uploader.rb

@@ -5,7 +5,7 @@ module Scrivito
         def upload_file(file)
           upload_permission = CmsRestApi.get('blobs/upload_permission')
 
-          fields = upload_permission['fields'].to_a + [[:file, file]]
+          fields = upload_permission['fields'].merge({file: file})
 
           # Net/HTTP does not support multipart forms
           RestClient.post(upload_permission['url'], fields)

data/lib/scrivito/configuration.rb

@@ -32,6 +32,8 @@ module Scrivito
       # 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>.
@@ -50,6 +52,34 @@ module Scrivito
         end
       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
+      # @yieldparam [String] user_id id of the user
+      # @yieldreturn [Scrivito::User] if the user with the given user id was found
+      # @yieldreturn [NilClass] if the user with the given user id was not found
+      # @raise [Scrivito::ScrivitoError] if the proc returns neither a {Scrivito::User}, nor +nil+
+      # @note This configuration key is optional. If it is not configured the in-place GUI would
+      #   behave normally, but would not be able to find any users.
+      # @example Return a "dummy" {Scrivito::User}
+      #   Scrivito.configure do |config|
+      #     config.find_user do |user_id|
+      #       Scrivito::User.new(user_id)
+      #     end
+      #   end
+      # @example Find the user with a custom user model and convert it to a {Scrivito::User}
+      #   Scrivito.configure do |config|
+      #     config.find_user do |user_id|
+      #       my_user = MyUserModel.find(user_id)
+      #       if my_user
+      #         my_user.to_scrivito_user
+      #       end
+      #     end
+      #   end
+      def find_user(&find_user_proc)
+        self.find_user_proc = find_user_proc
+      end
+
       # TODO: Legacy compatiblity. Remove when DisplayHelper gets removed.
       def editor_interface_enabled?
         false
@@ -150,7 +180,7 @@ module Scrivito
         self.endpoint = 'api.scrivito.com'
       end
 
-      attr_accessor :choose_homepage_callback
+      attr_accessor :choose_homepage_callback, :activate_users_and_permissions
 
       # Configure a callback to be invoked when the Scrivito SDK delivers the homepage.
       # The given callback will receive the rack env
@@ -175,7 +205,7 @@ module Scrivito
 
       def obj_formats
         @obj_formats ||= {
-          '_changes_list' => proc do |obj|
+          '_default' => proc do |obj|
             {
               id: obj.id,
               obj_class_name: obj.obj_class_name,

data/lib/scrivito/connection_manager.rb

@@ -89,12 +89,7 @@ module Scrivito
     end
 
     def user_agent
-      @user_agent ||= (
-        gem_info = Gem.loaded_specs["scrivito_sdk"]
-        if gem_info
-          "#{gem_info.name}-#{gem_info.version}"
-        end
-      )
+      @user_agent ||= "#{GemInfo.name}-#{GemInfo.version}"
     end
   end
 end

data/lib/scrivito/content_conversion.rb

@@ -28,15 +28,19 @@ module Scrivito
 
     def self.convert_linklist_urls(linklist, request_host, request_port)
       linklist.map do |link_data|
-        if link_data.has_key?(:url)
-          link_data.delete(:obj_id)
-          url = link_data.delete(:url)
-          link = Link.parse(url, request_host, request_port)
-          link_data.merge!(link.to_cms_api_linklist_params)
-        end
+        convert_link(link_data, request_host, request_port)
+      end
+    end
 
-        link_data
+    def self.convert_link(link_data, request_host, request_port)
+      if link_data && link_data.has_key?(:url)
+        link_data.delete(:obj_id)
+        url = link_data.delete(:url)
+        link = Link.parse(url, request_host, request_port)
+        link_data.merge!(link.to_cms_api_linklist_params)
       end
+
+      link_data
     end
   end
 

data/lib/scrivito/editing_context.rb

@@ -16,6 +16,18 @@ class EditingContext
     unless @editor_already_evaluated
       @editor_already_evaluated = true
       @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."
+        )
+        else
+          @editor = User.anonymous_admin
+        end
+      end
     end
 
     @editor

data/lib/scrivito/gem_info.rb

@@ -0,0 +1,13 @@
+module Scrivito
+  module GemInfo
+    class << self
+      delegate :name, :version, to: :spec
+
+      private
+
+      def spec
+        @spec ||= Gem.loaded_specs['scrivito_sdk']
+      end
+    end
+  end
+end

data/lib/scrivito/membership.rb

@@ -0,0 +1,26 @@
+module Scrivito
+
+  # @api beta
+  # Represents a Membership of a {User} in a {Workspace}
+  class Membership
+
+    # @api beta
+    # The {User User's} id
+    #
+    # @return [String]
+    attr_reader :user_id
+
+    # @api beta
+    # The role associated with this membership.
+    #
+    # @note Currently the only available role is "owner".
+    #
+    # @return [String] the name of role
+    attr_reader :role
+
+    def initialize(user_id, data)
+      @user_id = user_id
+      @role = data.fetch("role")
+    end
+  end
+end

data/lib/scrivito/memberships_collection.rb

@@ -0,0 +1,78 @@
+module Scrivito
+  # @api beta
+  # The MembershipsCollection includes all members of a given {Workspace}.
+  # You can access it using {Workspace#memberships} method.
+  class MembershipsCollection
+    extend Forwardable
+    include Enumerable
+
+    attr_reader :workspace
+
+    # @api beta
+    # @!method each
+    # Iterate over all {Membership Memberships} of a specfic {Workspace}. Allows
+    # you to use all methods defined by ruby's Enumerable module.
+    #
+    # @yield [Membership]
+    #
+    # @return [Enumerator] if no block is given an Enumerator is returned
+    #
+    # @example
+    #   # Optain all owners of a workspace
+    #   my_workspace.memberships.select do |membership|
+    #     membership.role == "owner"
+    #   end
+    #
+    #   # Get an array of all the members' user_ids
+    #   my_workspace.memberships.map { |membership| membership.user_id }
+    #
+    #   # Or use it directly to iterate over all items
+    #   my_workspace.memberships.each do |membership|
+    #     puts "User #{membership.user_id} has the role #{membership.role}"
+    #   end
+    #
+    # @note For a complete list of all provided methods please view the
+    #   documentation of the Enumerable module
+    def_delegator :memberships, :each
+
+    def initialize(workspace)
+      @workspace = workspace
+    end
+
+    # @api beta
+    # return a hash where the keys are user_ids and the values are Membership-Instances
+    # @return [Hash<String, Membership>]
+    def to_h
+      memberships.inject(HashWithIndifferentAccess.new) do |hash, membership|
+        hash[membership.user_id] = membership
+        hash
+      end
+    end
+
+    # @api beta
+    # Returns the membership for a user or nil
+    #
+    # @param  [User, String] id_or_user
+    # @return [Membership, nil]
+    def [](id_or_user)
+      id = if id_or_user.respond_to?(:id)
+        id_or_user.id
+      else
+        id_or_user
+      end
+
+      to_h[id]
+    end
+
+    private
+
+    def memberships
+      @memberships ||= begin
+        workspace.data.memberships.map do |id, data|
+          Membership.new(id, data)
+        end
+      end
+    end
+
+  end
+end

data/lib/scrivito/migrations/migration.rb

@@ -9,7 +9,7 @@ module Scrivito
     #
     #   class CreateTestAttribute < Scrivito::Migrations::Migration
     #     def up
-    #       add_attribute_to('homepage', :name => 'test', :type => 'string')
+    #       ObjClass.find('Homepage').attributes.add(Attribute.new(name: 'test', type: :string))
     #     end
     #   end
     class Migration

data/lib/scrivito/migrations/migration_dsl.rb

@@ -5,6 +5,8 @@ module Scrivito
     module MigrationDsl
       # Adds an attribute to an object class.
       #
+      # @deprecated Please use {AttributeCollection#add} instead.
+      #
       # @example Add "test" attribute to object class "Foo.
       #
       #   add_attribute_to('Foo', { name: 'test', type: 'string' })
@@ -14,6 +16,11 @@ module Scrivito
       #
       # @return nothing
       def add_attribute_to(obj_class_name, params)
+        Deprecation.warn_method(
+          'add_attribute_to',
+          'ObjClass#attributes.add(Attribute.new(params))'
+        )
+
         attributes = get_obj_class(obj_class_name)['attributes']
         attributes << params
 
@@ -22,6 +29,8 @@ module Scrivito
 
       # Deletes an attribute from an object class.
       #
+      # @deprecated Please use {Attribute#destroy} instead.
+      #
       # @example Delete "test" attribute from object class "Foo.
       #
       #   delete_attribute_from('Foo', 'test')
@@ -32,6 +41,11 @@ module Scrivito
       #
       # @return nothing
       def delete_attribute_from(obj_class_name, attribute_name)
+        Deprecation.warn_method(
+          'delete_attribute_from',
+          'ObjClass#attributes[attribute_name].destroy()'
+        )
+
         attributes = get_obj_class(obj_class_name)['attributes']
         attributes = attributes.delete_if do |attribute|
           attribute['name'] == attribute_name.to_s
@@ -42,6 +56,8 @@ module Scrivito
 
       # Updates an attribute for an object class.
       #
+      # @deprecated Please use {Attribute#update} instead.
+      #
       # @example Update "test" attribute for object class "Foo.
       #
       #   update_attribute_for('Foo', 'test', { title: 'New Title' })
@@ -53,6 +69,11 @@ module Scrivito
       #
       # @return nothing
       def update_attribute_for(obj_class_name, attribute_name, params)
+        Deprecation.warn_method(
+          'update_attribute_for',
+          'ObjClass#attributes[attribute_name].update(params)'
+        )
+
         attribute_name = attribute_name.to_s
         attributes = get_obj_class(obj_class_name)['attributes']
         found = false
@@ -75,6 +96,8 @@ module Scrivito
 
       # Creates a CMS object class.
       #
+      # @deprecated Please use {ObjClass.create} instead.
+      #
       # @example Create "Test" Object Class
       #
       #   create_obj_class(name: 'Test', type: 'publication')
@@ -85,6 +108,8 @@ module Scrivito
       # @return nothing
       # @api public
       def create_obj_class(attributes = {})
+        Deprecation.warn_method('create_obj_class', 'ObjClass.create(attributes)')
+
         endpoint = "workspaces/#{Workspace.current.id}/obj_classes"
 
         CmsRestApi.post(endpoint, obj_class: attributes)
@@ -92,6 +117,8 @@ module Scrivito
 
       # Fetches all object attributes and their values.
       #
+      # @deprecated Please use {BasicObj.find} instead.
+      #
       # @example Get all attributes for the obj with id "abc123"
       #
       #   get_obj('abc123')
@@ -101,6 +128,8 @@ module Scrivito
       # @return [Hash] a hash with attributes and their values.
       # @api public
       def get_obj(id)
+        Deprecation.warn_method('get_obj', 'Obj.find(id)')
+
         endpoint = "workspaces/#{Workspace.current.id}/objs/#{id}"
 
         CmsRestApi.get(endpoint)
@@ -108,6 +137,8 @@ module Scrivito
 
       # Fetches all object class attributes and their values.
       #
+      # @deprecated Please use {ObjClass.find} instead.
+      #
       # @example Get all attributes for the object class "Test"
       #
       #   get_obj_class('Test')
@@ -117,6 +148,8 @@ module Scrivito
       # @return [Hash] a hash with attributes and their values.
       # @api public
       def get_obj_class(id)
+        Deprecation.warn_method('get_obj_class', 'ObjClass.find(id)')
+
         endpoint = "workspaces/#{Workspace.current.id}/obj_classes/#{id}"
 
         CmsRestApi.get(endpoint)
@@ -124,6 +157,8 @@ module Scrivito
 
       # Updates a CMS object class.
       #
+      # @deprecated Please use {ObjClass#update} instead.
+      #
       # @example Update the title of the "Test" Object Class
       #
       #   update_obj_class('Test', title: 'Test Title')
@@ -134,6 +169,8 @@ module Scrivito
       # @return nothing
       # @api public
       def update_obj_class(id, attributes = {})
+        Deprecation.warn_method('update_obj_class', 'ObjClass#update(attributes)')
+
         endpoint = "workspaces/#{Workspace.current.id}/obj_classes/#{id}"
 
         CmsRestApi.put(endpoint, obj_class: attributes)

data/lib/scrivito/obj_class.rb

@@ -0,0 +1,282 @@
+module Scrivito
+  # This class represents a CMS obj class. Obj classes can be created, updated and all properties
+  # can be read. The class also provides methods to find obj classes. The attributes of an obj class
+  # are defined by {Scrivito::Attribute} instances.
+  #
+  # @api public
+  class ObjClass
+    include ModelIdentity
+
+    class << self
+      # Returns all the obj classes.
+      #
+      # @api public
+      #
+      # @example Find all obj classes in the current {Scrivito::Workspace}.
+      #   ObjClass.all
+      #
+      # @return [Array<Scrivito::ObjClass>]
+      def all
+        results = CmsRestApi.get("workspaces/#{Workspace.current.id}/obj_classes")['results']
+
+        results.map do |properties|
+          new(properties)
+        end
+      end
+
+      # Finds an obj class by its name.
+      #
+      # @api public
+      #
+      # @example Find the obj class named "Homepage" in the current {Scrivito::Workspace}.
+      #   ObjClass.find('Homepage')
+      #
+      # @param [String] name The name of the obj class.
+      # @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}'."
+        end
+
+        new(response)
+      end
+
+      # Creates a new obj class and persists it in the CMS.
+      #
+      # @api public
+      #
+      # This allows you to set the different properties of an obj class by
+      # providing a hash with the property names as keys and the values you want
+      # to set as values. Attributes can be either given as {Scrivito::Attribute} instances or as
+      # an attribute property hash.
+      #
+      # @example Create a non-binary obj class.
+      #   ObjClass.create(name: 'Homepage', is_binary: false)
+      #
+      # @example Create a binary obj class.
+      #   ObjClass.create(name: 'Image', is_binary: true)
+      #
+      # @example Create an obj class with attributes passed in as an Array of attribute property hashes.
+      #   ObjClass.create(name: 'Blog', attributes: [
+      #     { name: 'headline', type: :string },
+      #     { name: 'category', type: :enum, values: %w(tech social) },
+      #   ])
+      #
+      # @example Create an obj class with attributes passed in as an Array of {Scrivito::Attribute} instances.
+      #   ObjClass.create(name: 'Blog', attributes: [
+      #     Attribute.new(name: 'headline', type: :string),
+      #     Attribute.new(name: 'category', type: :enum, values: %w(tech social)),
+      #   ])
+      #
+      # @param [Hash] properties
+      # @option properties [String] :name The name of the obj class.
+      # @option properties [Boolean] :is_binary Is this a binary or non-binary obj class?
+      # @option properties [Boolean] :is_active Is it possible to create instances of this obj class?
+      # @option properties [Array<Scrivito::Attribute>, Array<Hash>] :attributes A list of
+      #   attributes for this obj class. Can be either a list of attribute instances or attribute
+      #   property hashes.
+      #
+      # @return [Scrivito::ObjClass]
+      def create(properties)
+        properties = properties.with_indifferent_access
+
+        unless properties.has_key?(:is_binary)
+          raise ScrivitoError, 'The "is_binary" property is mandatory. Please provide' \
+            ' a hash containing an "is_binary" key with true or false value.'
+        end
+
+        if properties[:attributes]
+          properties[:attributes].map! do |attribute|
+            attribute.respond_to?(:to_cms_rest_api) ? attribute : Attribute.new(attribute)
+          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
+      end
+
+      private
+
+      # Formats obj class properties into a CMS REST API format.
+      # @param [Hash] properties
+      # @return [Hash] Properties formated for the CMS.
+      def format_properties_for_cms(properties)
+        params = properties.dup
+
+        if params.has_key?(:is_binary)
+          params[:type] = params.delete(:is_binary) ? :generic : :publication
+        end
+
+        if params.has_key?(:attributes)
+          params[:attributes] = params[:attributes].map do |attribute|
+            attribute.to_cms_rest_api
+          end
+        end
+
+        params
+      end
+    end
+
+    # Initializes a new obj class. It expects the CMS backend representation of an obj class.
+    #
+    # See {ObjClass.create} for a detailed overview of how to set properties.
+    #
+    # @param [Hash] properties
+    # @return [Scrivito::ObjClass]
+    # @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
+    end
+
+    # Returns the name of this obj class.
+    # @api public
+    # @return [String]
+    def name
+      @name
+    end
+
+    # 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
+    #
+    # @example Find an attribute named "locale" for the obj class "Homepage".
+    #   ObjClass.find('Homepage').attributes['locale']
+    #
+    # @example Add a new +string+ attribute named "headline" to the "Homepage" obj class by providing an attribute property hash.
+    #   ObjClass.find('Homepage').attributes.add(name: 'headline', type: :string)
+    #
+    # @example Add a new +enum+ attribute named "category" to the "Homepage" obj class by providing an attribute instance.
+    #   attribute = Attribute.new(name: 'category', type: :enum, values: %w(tech social))
+    #   ObjClass.find('Homepage').attributes.add(attribute)
+    #
+    # @example Iterate over the list of attributes from the obj class "Homepage" and print their name and type.
+    #   ObjClass.find('Homepage').attributes.each do |attribute|
+    #     puts "#{attribute.name}:#{attribute.type}"
+    #   end
+    #
+    # @return [Scrivito::AttributeCollection]
+    def attributes
+      @attributes
+    end
+
+    # Updates this obj class and persists the changes in the CMS. It is not possible to
+    # update the +name+ or +is_binary+ property.
+    #
+    # @api public
+    #
+    # See {Scrivito::ObjClass.create} for a detailed overview of
+    # what properties are allowed and how to set them.
+    #
+    # @param [Hash] properties
+    #
+    # @raise [ScrivitoError] Raised when trying to change +name+ or +is_binary+.
+    #
+    # @return [nil]
+    def update(properties)
+      params = properties.with_indifferent_access
+
+      if params.has_key?(:is_binary)
+        raise ScrivitoError, "#{self.class} does not support changing 'is_binary'. Please remove" \
+          " the key from the properties."
+      end
+
+      if params.has_key?(:name)
+        raise ScrivitoError, "#{self.class} does not support changing 'name'. Please remove" \
+          " the key from the properties."
+      end
+
+      if params.has_key?(:attributes)
+        params[:attributes].map! do |attribute|
+          unless attribute.respond_to?(:to_cms_rest_api)
+            attribute = Attribute.new(attribute)
+          end
+
+          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)
+
+      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] || [])
+    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)
+        attribute.obj_class = self
+        attribute
+      end
+
+      AttributeCollection.new(self, attributes)
+    end
+  end
+end