scrivito_sdk 1.0.0 → 1.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0eb4d80674f7358857ae70658858582add7287a
-  data.tar.gz: 40285d81b022ae837d5faf654813fe293045a96a
+  metadata.gz: 12a55c387b16a4a537845c0ef7d10d00b4c6bd4a
+  data.tar.gz: e79c326cc3f757de2d46b05d4287ab0548550aeb
 SHA512:
-  metadata.gz: fef1e96a24e7dddf8f3cff047a346e876d4a2327aec887f56aa23cd9c4d198172523242ccf4517ef758403497166b309d112eb4974ae8950c01da4483f6e1cdb
-  data.tar.gz: d8138405353535ff21989e5a14740e0ecd7b95e4081fcb2a796e157a97603e89fb80512687eb99322a3828fdb420bf2bcf7cc30e823f0fcd46b760f9443aac32
+  metadata.gz: 1a9338acbdbd0901b6ed31bc8962c1278f9057c507f2af2791c83291de9480f0d8230fb58acd1c039753a34ab18fd5a2033c39676f67d09ba0205b9c92b7e4e0
+  data.tar.gz: cd8ba88553f5bf4a3974a7a1901391dda745100e3749b54801e3507825caa8e52817506fe0c3622f105363311db88841596a53c5df4e2b15a3ee88843750c0ff

data/.yardopts

@@ -6,3 +6,4 @@
 --embed-mixin AttributeContent
 --embed-mixin Scrivito::AttributeContent::ClassMethods
 --exclude lib/scrivito/cms_dispatch_controller.rb
+--exclude app/controllers/scrivito/legacy_redirect_controller.rb

data/README.md

@@ -1,6 +1,6 @@
 # Scrivito SDK
 
-[![Gem Version](https://badge.fury.io/rb/scrivito_sdk.png)](http://badge.fury.io/rb/scrivito_sdk)
+[![Gem Version](https://badge.fury.io/rb/scrivito_sdk.svg)](https://badge.fury.io/rb/scrivito_sdk)
 
 The Scrivito SDK makes CMS objects maintained by means of the cloud-based Scrivito CMS available
 to your Rails application. It offers easy-to-use functionality for rendering CMS content, doing

data/app/controllers/scrivito/legacy_redirect_controller.rb

@@ -0,0 +1,11 @@
+module Scrivito
+  class LegacyRedirectController < ActionController::Metal
+    include ActionController::Redirecting
+    include Rails.application.routes.url_helpers
+
+    def index
+      route = Route.find(_routes, :slug_id)
+      redirect_to route.generate_path(self, params.slice(:id, :slug).symbolize_keys)
+    end
+  end
+end

data/app/controllers/scrivito/objs_controller.rb

@@ -35,8 +35,12 @@ module Scrivito
       params_parser = ObjCreateParamsParser.new(request.host, request.port)
       @obj = Obj.create(params_parser.parse(params[:obj]), scrivito_user: scrivito_user)
       render :obj
-    rescue ObjClassNotFound
-      head :not_found
+    rescue ObjClassNotFound => e
+      raise ClientError.new(
+        "You've tried to create a CMS object based on the \"#{e.message}\" class, which is "\
+        "either missing or not suitable for the object.",
+        400
+      )
     end
 
     def details
@@ -48,14 +52,12 @@ module Scrivito
       params_parser = ObjUpdateParamsParser.new(request.host, request.port,
         current_obj: current_obj, scrivito_user: scrivito_user)
       current_obj.update(params_parser.parse(params[:obj]))
-    rescue ObjClassNotFound
-      head :not_found
     end
 
     def destroy
       in_selected_workspace do
         parent = current_obj.parent
-        @redirect_to = parent ? scrivito_path(parent) : scrivito_root_path
+        @redirect_to = parent ? scrivito_path(parent) : "/"
         current_obj.destroy
       end
     end
@@ -94,6 +96,13 @@ module Scrivito
       in_selected_workspace { @is_outdated = current_obj.outdated? }
     end
 
+    def binary_no_cache
+      in_selected_workspace do
+        binary = current_obj[params[:attribute_name]]
+        @no_cache_url = binary.no_cache_url
+      end
+    end
+
     def mark_resolved
       in_selected_workspace { current_obj.mark_resolved }
       render_empty_json
@@ -158,6 +167,7 @@ module Scrivito
           return render action: 'search/facet'
         end
 
+        @batch = @enumerator.fetch_batch(params[:continuation])
         render :search
       end
     end

data/app/controllers/scrivito/webservice_controller.rb

@@ -1,9 +1,10 @@
 module Scrivito
 
 class WebserviceController < ActionController::Base
-  rescue_from ClientError do |exception|
-    @exception = exception
-    render 'scrivito/webservice/error', formats: :json, status: exception.http_code
+  rescue_from ApplicationError, ClientError, ResourceNotFound do |error|
+    @error = error
+    @timestamp = Time.zone.now
+    render 'scrivito/webservice/error', formats: :json, status: error.http_code
   end
 
   before_filter :merge_correctly_parsed_json_params

data/app/controllers/scrivito/workspaces_controller.rb

@@ -1,9 +1,20 @@
 module Scrivito
   class WorkspacesController < WebserviceController
-    around_action :authorize_workspace_create,          only: :create
-    around_action :authorize_current_workspace_read,    only: :show
-    around_action :authorize_current_workspace_write,   only: [:update, :destroy, :rebase]
-    around_action :authorize_current_workspace_publish, only: [:check, :publish]
+    def self.restrict_access_to(action_name, require_permission:)
+      around_action only: action_name do |_, block|
+        subject = params.has_key?(:id) ? current_workspace : :workspace
+        authorize_workspace_access(require_permission, subject, &block)
+      end
+    end
+
+    restrict_access_to :create,      require_permission: :create
+    restrict_access_to :show,        require_permission: :read
+    restrict_access_to :rename,      require_permission: :write
+    restrict_access_to :memberships, require_permission: :invite_to
+    restrict_access_to :destroy,     require_permission: :delete
+    restrict_access_to :rebase,      require_permission: :write
+    restrict_access_to :check,       require_permission: :publish
+    restrict_access_to :publish,     require_permission: :publish
 
     def index
       @workspaces = Workspace.all.select(&method(:can_user_read_workspace?))
@@ -25,8 +36,13 @@ module Scrivito
       end
     end
 
-    def update
-      current_workspace.update(workspace_params)
+    def rename
+      current_workspace.update(workspace_params.slice(:title))
+      render_empty_json
+    end
+
+    def memberships
+      current_workspace.update(workspace_params.slice(:memberships))
       render_empty_json
     end
 
@@ -65,9 +81,8 @@ module Scrivito
     end
 
     def conditional_publish
-      task_unaware_request(:put, current_workspace_backend_path('/publish'), {
-        if_content_state_id_equals: current_workspace.content_state.content_state_id
-      })
+      task_unaware_request(:put, current_workspace_backend_path('/publish'),
+        if_content_state_id_equals: current_workspace.content_state_id)
     end
 
     def valid_publish_request?
@@ -78,26 +93,6 @@ module Scrivito
       Workspace::PublishChecker.new(current_workspace, scrivito_user)
     end
 
-    def authorize_workspace_create(&block)
-      authorize_workspace_access(:create, :workspace, &block)
-    end
-
-    def authorize_current_workspace_read(&block)
-      authorize_current_workspace_access(:read, &block)
-    end
-
-    def authorize_current_workspace_write(&block)
-      authorize_current_workspace_access(:write, &block)
-    end
-
-    def authorize_current_workspace_publish(&block)
-      authorize_current_workspace_access(:publish, &block)
-    end
-
-    def authorize_current_workspace_access(verb, &block)
-      authorize_workspace_access(verb, current_workspace, &block)
-    end
-
     def current_workspace
       @current_workspace ||= Workspace.find(params[:id])
     end

data/app/helpers/scrivito_helper.rb

@@ -75,39 +75,64 @@ module ScrivitoHelper
     )).render(html_options, &block)
   end
 
+  #
+  # Renders a navigation ready for in-place editing.
   #
   # @api public
   #
-  # @param tag_name [String, Symbol] Name of the html tag (e.g. +:h1+ or +:div+).
-  # @param obj [Scrivito::BasicObj] A {Scrivito::BasicObj} from which field_name is read.
-  # @param field_name [String, Symbol] Which field_name of the Obj should be rendered. Currently
-  #   only +toclist+ is supported
-  # @param options [Hash] Additional options, which are passed to +content_tag+. Use them to add
-  #   HTML attributes to the tag
+  # If a navigation is rendered using this helper method, a special menu is attached to it that lets
+  # you change the order of the child pages or insert a new child.
   #
-  # @yieldparam [Scrivito::ChildListTag::ObjTag] list An instance, where +tag+ should be called once.
-  # @yieldparam [Scrivito::BasicObj] child Each child of +toclist+
+  # For making the child pages sortable, the parent {Scrivito::BasicObj Obj} requires a
+  # +referencelist+ attribute named +child_order+. When creating a page model using the page
+  # generator, such an attribute is automatically added to the model.
   #
-  # @return [String] The rendered html tag
+  # @param tag_name [String, Symbol] Name of the outer HTML tag (e.g. +:ul+ or +:div+).
+  # @param obj [Scrivito::BasicObj] The parent {Scrivito::BasicObj Obj}, on which +method_name+ will
+  #   be called in order to fetch the children.
+  # @param method_name [String, Symbol] Name of the method to be called on the parent
+  #   {Scrivito::BasicObj Obj} in order to fetch the children. Currently, only +toclist+ is
+  #   supported.
+  # @param options [Hash] Options to be passed to +content_tag+. Use them to add HTML attributes to
+  #   the tag.
   #
-  # @example
-  #   scrivito_tag_list(:div, @obj, :toclist, class: "very_important") do |list, child|
-  #     list.tag(:div, class: "also_important") do
+  # @yieldparam [Scrivito::ChildListTag::ObjTag] list An object on which the
+  #   {Scrivito::ChildListTag::ObjTag#tag tag} method should be called once per child to enable
+  #   in-place editing.
+  # @yieldparam [Scrivito::BasicObj] child Each child of +toclist+.
+  #
+  # @return [String] The rendered HTML string.
+  #
+  # @see Scrivito::ChildListTag::ObjTag#tag
+  #
+  # @example Renders a navigation for an +@obj+ with two children in its +toclist+, whose titles are +"Toys"+ and +"Electronics"+ respectively:
+  #   scrivito_tag_list(:ul, @obj, :toclist, class: "my_list") do |list, child|
+  #     list.tag(:li, class: "my_list_element") do
   #       link_to(scrivito_path(child)) do
   #         scrivito_tag(:span, child, :title)
   #       end
   #     end
   #   end
   #
-  #   # result for an obj with two children:
   #   #
-  #   # <div class="very_important">
-  #   #   <div class="also_important"><a href="/child1"><span>Child 1</span></a></div>
-  #   #   <div class="also_important"><a href="/child2"><span>Child 2</span></a></div>
-  #   # </div>
+  #   # Basically, the rendered HTML will look like this:
+  #   #
+  #   # <ul class="my_list">
+  #   #   <li class="my_list_element">
+  #   #     <a href="/toys-902b3e8d6ec861c1">
+  #   #       <span>Toys</span>
+  #   #     </a>
+  #   #   </li>
+  #   #   <li class="my_list_element">
+  #   #     <a href="/electronics-59c6995988ce78f4">
+  #   #       <span>Electronics</span>
+  #   #     </a>
+  #   #   </li>
+  #   # </ul>
+  #   #
   #
-  def scrivito_tag_list(tag_name, obj, field_name, options = {}, &block)
-    Scrivito::ChildListTag.new(tag_name, obj, field_name.to_s, self).render(options, &block)
+  def scrivito_tag_list(tag_name, obj, method_name, options = {}, &block)
+    Scrivito::ChildListTag.new(tag_name, obj, method_name.to_s, self).render(options, &block)
   end
 
   #
@@ -181,30 +206,29 @@ module ScrivitoHelper
   end
 
   #
-  # Renders an attribute <em>value</em> of a CMS model.
+  # Renders an attribute value of a CMS model, taking its type into account.
   #
-  #   scrivito_value(@obj.title)
-  # Renders the value, taking its type into account.
-  # * An HtmlString will be exported by converting its links
-  # * A Time will be exported in an international form: Year-Month-Day Hour:Minutes
-  # * A non-HTML String will be quoted
-  # * other values will be rendered unchanged
+  # @api public
   #
-  # @note Content rendered using this method
-  #   will not be editable in the Scrivito UI.
-  #   If you want In-Place-Editing, use {ScrivitoHelper#scrivito_tag} instead.
+  # Links inside +html+ attributes are rendered using the routing of the application. Values from
+  # +string+ attributes are escaped. For other attribute types, a simple default representation is
+  # rendered.
   #
-  # @api public
+  # @example
+  #   scrivito_value(@obj.title)
+  #
+  # @note Content rendered using this method will not be editable in the Scrivito UI. If you want
+  #   in-place editing, use {ScrivitoHelper#scrivito_tag} instead.
   #
   def scrivito_value(value)
+    renderer = Scrivito::AttributeValueRenderer.new(self)
+
     case value
-      when Scrivito::HtmlString
-        Scrivito::CmsRouting.new(request, main_app, scrivito_engine).convert_links(value).html_safe
-      when String then h(value)
-      when Time then h(l(value))
-      when Scrivito::BasicWidget
-        render(template: value.show_view_path, locals: {widget: value})
-      else value
+    when Scrivito::BasicWidget then render(template: value.show_view_path, locals: {widget: value})
+    when Scrivito::HtmlString  then renderer.render_as_html(value)
+    when String                then renderer.render_as_string(value)
+    when Time                  then renderer.render_as_date(value)
+    else value
     end
   end
 
@@ -398,4 +422,25 @@ module ScrivitoHelper
       Please use helper method `scrivito_user` instead.
     }
   end
+
+  # @api public
+  #
+  # This method wraps Rails' built-in fragment caching to work with content delivered by Scrivito.
+  # Fragment caching applies to computed parts of views and helps to improve performance. The
+  # Rails guides provide an excellent introduction to caching if you haven't used it yet.
+  #
+  # The +scrivito_cache+ method extends built-in fragment caching so that cached
+  # parts of a view are automatically recomputed when Scrivito content changes. The
+  # fragments are only cached for the published content. In editable working copies
+  # no caching takes place, and the fragments are computed for every request.
+  #
+  # @param key [String] a name describing the data to be cached.
+  # @param options [Hash] a hash that enables further configuration of the fragment
+  #   cache. The options are passed to the +cache+ helper of Rails. See the Rails
+  #   {http://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html#method-i-cache documentation}
+  #   for details.
+  def scrivito_cache(key, options=nil, &block)
+    workspace = Scrivito::Workspace.current
+    cache_if(workspace.published?, [workspace.cache_key, key], options, &block)
+  end
 end

data/app/views/scrivito/objs/binary_no_cache.json.jbuilder

@@ -0,0 +1 @@
+json.no_cache_url @no_cache_url

data/app/views/scrivito/objs/search.json.jbuilder

@@ -1,6 +1,6 @@
-json.total @enumerator.size
-json.hits do
-  json.merge!(@enumerator.load_batch.map { |obj|
-    @formatter.call(obj, scrivito_user, controller.view_context)
-  })
+json.total @batch.total
+json.continuation @batch.continuation
+json.hits @batch.objs do |obj|
+  json.id obj.id
+  json.serialized_obj @formatter.call(obj, scrivito_user, controller.view_context)
 end

data/app/views/scrivito/webservice/error.json.jbuilder

@@ -1,2 +1,2 @@
-json.error @exception.message
-json.code  @exception.backend_code
+json.merge! @error.as_json
+json.timestamp @timestamp.to_s

data/config/ca-bundle.crt

@@ -1,7 +1,7 @@
 ##
 ## Bundle of CA Root Certificates
 ##
-## Certificate data from Mozilla as of: Mon Dec  7 13:17:14 2015
+## Certificate data from Mozilla as of: Fri Jan  8 14:27:07 2016
 ##
 ## This is a bundle of X.509 certificates of public Certificate Authorities
 ## (CA). These were automatically extracted from Mozilla's root certificates

data/config/precedence_routes.rb

@@ -3,64 +3,67 @@ Rails.application.routes.draw do
 end
 
 Scrivito::SdkEngine.routes.draw do
-  resources :objs, controller: 'scrivito/objs', path: '__scrivito/objs',
-      only: [:show, :create, :update, :destroy], defaults: {format: :json} do
-    collection do
-      get :page_class_selection
-      get :search
-    end
-
-    member do
-      get :widget
-      get :widget_class_selection
-      get :widget_modification
-      get :conflicting_workspaces
-      get :is_outdated
+  get 'scrivito', to: 'scrivito/ui#index'
+  get 'scrivito/*application_path', to: 'scrivito/ui#index', format: false
 
-      post :copy
-      post :duplicate
+  scope '__scrivito', module: 'scrivito' do
+    get ':id', to: 'cms_dispatch#index', as: :base_id, constraints: {id: /\h{16}/}
 
-      put :revert
-      put :restore
-      put :mark_resolved
-      put :destroy_widget
-      put :revert_widget
-      put :restore_widget
-      put :transfer_modifications
-    end
-  end
+    resources :objs, controller: 'objs', only: [:show, :create, :update, :destroy],
+        defaults: {format: :json} do
+      collection do
+        get :page_class_selection
+        get :search
+      end
 
-  resources :tasks, controller: 'scrivito/tasks', path: '__scrivito/tasks', only: [:show],
-    defaults: {format: :json}
+      member do
+        get :widget
+        get :widget_class_selection
+        get :widget_modification
+        get :conflicting_workspaces
+        get :is_outdated
+        get :binary_no_cache
 
-  get '__scrivito/blobs/upload_permission' => 'scrivito/blobs#upload_permission',
-    defaults: {format: :json}
-  put '__scrivito/blobs/activate_upload' => 'scrivito/blobs#activate_upload',
-    defaults: {format: :json}
+        post :copy
+        post :duplicate
 
-  resources :workspaces,
-    controller: 'scrivito/workspaces',
-    path: '__scrivito/workspaces',
-    only: [:index, :show, :create, :update, :destroy],
-    defaults: {format: :json} do
-      member do
-        put :rebase
-        put :publish
-        get :check
+        put :revert
+        put :restore
+        put :mark_resolved
+        put :destroy_widget
+        put :revert_widget
+        put :restore_widget
+        put :transfer_modifications
       end
     end
 
-  get '__scrivito/users/suggest' => 'scrivito/users#suggest', defaults: {format: :json}
-  get '__scrivito/suggest_completion' => 'scrivito/completion#suggest', defaults: {format: :json}
+    resources :tasks, controller: 'tasks', only: [:show], defaults: {format: :json}
 
-  get '__scrivito/render_widget/:id/show_widget/:widget_id' => 'scrivito/cms_dispatch#show_widget'
-  get '__scrivito/render_widget/:id/widget_details/:widget_id' => 'scrivito/cms_dispatch#widget_details'
+    get 'blobs/upload_permission' => 'blobs#upload_permission', defaults: {format: :json}
+    put 'blobs/activate_upload' => 'blobs#activate_upload', defaults: {format: :json}
 
-  get '__scrivito/page_details/:id' => 'scrivito/cms_dispatch#page_details'
-  get '__scrivito/resource_details/:resource_id', to: 'scrivito/ui#index'
+    resources :workspaces,
+      controller: 'workspaces',
+      only: [:index, :show, :create, :destroy],
+      defaults: {format: :json} do
+        member do
+          put :rename
+          put :memberships
+          put :rebase
+          put :publish
+          get :check
+        end
+      end
 
-  get '__scrivito/to_binary' => 'scrivito/binary_redirect#to_binary', as: :binary
+    get 'users/suggest' => 'users#suggest', defaults: {format: :json}
+    get 'suggest_completion' => 'completion#suggest', defaults: {format: :json}
 
-  get 'scrivito', to: 'scrivito/ui#index'
-  get 'scrivito/*application_path', to: 'scrivito/ui#index', format: false
+    get 'render_widget/:id/show_widget/:widget_id' => 'cms_dispatch#show_widget'
+    get 'render_widget/:id/widget_details/:widget_id' => 'cms_dispatch#widget_details'
+
+    get 'page_details/:id' => 'cms_dispatch#page_details'
+    get 'resource_details/:resource_id', to: 'ui#index'
+
+    get 'to_binary' => 'binary_redirect#to_binary', as: :binary
+  end
 end

data/config/routes.rb

@@ -1,14 +1 @@
-Rails.application.routes.draw do
-  match '/', via: :all, to: 'scrivito/cms_dispatch#index', as: :scrivito_root
-
-  with_options via: :all, constraints: {id: /[0-9a-f]{16}/} do |proxy|
-    proxy.match '(/)(*slug-):id', to: 'scrivito/cms_dispatch#index', as: :cms_id
-    proxy.match ':id(/*slug)', to: 'scrivito/cms_dispatch#legacy', as: :cms_legacy_id
-  end
-
-  match '/*permalink',
-    to: 'scrivito/cms_dispatch#index',
-    as: :scrivito_permalink,
-    format: false,
-    via: :all
-end
+Scrivito::PresetRoutes.install_into(Rails.application.routes)