scrivito_sdk 1.6.1 → 1.7.0.rc1

data/lib/scrivito/cms_dispatch_controller.rb

@@ -6,23 +6,24 @@ module Scrivito
     include Scrivito::ControllerHelper
 
     def process(action)
-      CmsEnv.new(env).load
+      CmsEnv.new(request.env).load
 
       if obj_not_found? && editing_context.workspace_changed?
         redirect_to "/"
         return self.response
       end
 
-      controller = target_controller(env)
-      env["action_dispatch.request.path_parameters"]["controller"] = controller.controller_path
+      controller = target_controller(request.env)
+      request.env["action_dispatch.request.path_parameters"]["controller"] =
+        controller.controller_path
 
       if !obj_not_found? && action == 'index'
         action = loaded_obj.controller_action_name
       end
 
-      env["action_dispatch.request.path_parameters"]["action"] = action
+      request.env["action_dispatch.request.path_parameters"]["action"] = action
 
-      self.response = controller.action(action).call(env)
+      self.response = controller.action(action).call(request.env)
     end
 
     private
@@ -53,7 +54,7 @@ module Scrivito
     end
 
     def loaded_obj
-      env[CmsEnv::OBJ_ENV_KEY]
+      request.env[CmsEnv::OBJ_ENV_KEY]
     end
 
     def obj_not_found?

data/lib/scrivito/controller_actions.rb

@@ -16,15 +16,17 @@ module ControllerActions
   extend ActiveSupport::Concern
 
   included do
-    before_filter :require_authenticated_editor, only: [
+    before_action :require_authenticated_editor, only: [
       :show_widget,
       :widget_details,
       :page_details,
     ]
 
-    before_filter :load_object
+    before_action :load_object
 
-    hide_action :on_scrivito_widget_error
+    if LegacySwitch.rails4?
+      hide_action :on_scrivito_widget_error
+    end
 
     helper :scrivito
   end
@@ -44,7 +46,7 @@ module ControllerActions
     widget = load_widget
     widget_tag = Scrivito::WidgetTag.new(view_context, widget,
       render_context: params[:template_name], inner_tag: params[:inner_tag])
-    render text: widget_tag.render, layout: false
+    render plain: widget_tag.render, layout: false
   end
 
   def widget_details
@@ -168,7 +170,7 @@ module ControllerActions
       binary_routing = BinaryRouting.new(request, scrivito_engine)
       redirect_to binary_routing.resolved_binary_obj_url(@obj, binary)
     else
-      render text: 'Empty Blob', status: 404
+      render plain: 'Empty Blob', status: 404
     end
   end
 

data/lib/scrivito/legacy_switch.rb

@@ -0,0 +1,7 @@
+module Scrivito
+  module LegacySwitch
+    def self.rails4?
+      Rails::VERSION::MAJOR == 4
+    end
+  end
+end

data/lib/scrivito/obj_search_enumerator.rb

@@ -230,6 +230,21 @@ module Scrivito
   # fields, and boost parameters requested, as well as the number of words in a free text
   # search.
   #
+  # == Concurrent changes
+  #
+  # Please be aware that concurrent changes can change the search result and
+  # can yield incomplete results. This is due to the fact, that search results are lazily loaded in
+  # batches. If you want to modify the result of a search, please call +to_a+ first.
+  #
+  # @example Concurrent changes
+  #   # bad example
+  #   books = Book.where(:price, :equals, 10.99)
+  #   books.map { |book| book.update(price: 9.99) }
+  #
+  #   # good example
+  #   books = Book.where(:price, :equals, 10.99).to_a
+  #   books.map { |book| book.update(price: 9.99) }
+  #
   # @api public
   class ObjSearchEnumerator
     INVALID_NEGATED_OPERATORS = [:contains, :contains_prefix].freeze
@@ -475,7 +490,7 @@ module Scrivito
     #    @param [String] attribute the name of an attribute.
     #    @param [Hash] options the options to facet a request with.
     #    @option options [Integer] :limit maximum number of unique values to return.
-    #      Defaults to +20+.
+    #      Defaults to +10+.
     #    @option options [Integer] :include_objs maximum number of Objs to fetch for
     #      each unique value. Defaults to +0+.
     #    @return [Array<Scrivito::ObjFacetValue>] A list of unique values that were found for the

data/lib/scrivito/sdk_engine.rb

@@ -5,7 +5,7 @@ require 'net/http/post/multipart'
 
 module ::Scrivito
   class SdkEngine < Rails::Engine
-    config.to_prepare do
+    def self.to_prepare
       Scrivito::Configuration.to_prepare
 
       unless Rails.application.config.cache_classes
@@ -13,11 +13,17 @@ module ::Scrivito
       end
     end
 
+    if Scrivito::LegacySwitch.rails4?
+      config.to_prepare { SdkEngine.to_prepare }
+    else
+      ActiveSupport::Reloader.to_prepare { SdkEngine.to_prepare }
+    end
+
     # make sure our exceptions cause an adequate error page and http status code
     config.action_dispatch.rescue_responses.merge!("Scrivito::ResourceNotFound" => :not_found)
 
     initializer "scrivito.add_cms_routing_paths", :after => :add_routing_paths do |app|
-      precedence_route = File.expand_path("precedence_routes.rb", paths['config'].to_a.first)
+      precedence_route = root.join('config', 'precedence_routes.rb').to_s
       app.routes_reloader.paths.unshift(precedence_route)
     end
 
@@ -51,17 +57,18 @@ module ::Scrivito
         scrivito_ui_redirect.js
         scrivito_ui.css
         scrivito_ui.js
-        scrivito_sdk.js
+        scrivito_with_js_sdk.js
       ]
       app.config.assets.precompile += %w(*.png *.jpg *.jpeg *.gif)
     end
 
     config.autoload_paths += paths['lib'].to_a
     config.autoload_once_paths += paths['lib'].to_a
+    config.eager_load_paths += [root.join('lib', 'scrivito').to_s]
 
-    config.app_middleware.use "Scrivito::EditingContextMiddleware"
-    config.app_middleware.use "Scrivito::CacheMiddleware"
-    config.app_middleware.use "Scrivito::WorkspaceSelectionMiddleware"
+    config.app_middleware.use Scrivito::EditingContextMiddleware
+    config.app_middleware.use Scrivito::CacheMiddleware
+    config.app_middleware.use Scrivito::WorkspaceSelectionMiddleware
   end
 end
 

data/lib/scrivito/test_request.rb

@@ -26,15 +26,33 @@ module Scrivito
     #     end
     #   end
     #
-    def for_scrivito_obj(test_obj = nil)
+    def for_scrivito_obj(test_obj = nil, routes = nil)
       env[Scrivito::CmsEnv::OBJ_ENV_KEY] = test_obj if test_obj
 
+      unless Scrivito::LegacySwitch.rails4?
+        # If +assign_parameters+ is monkey patched, then +generate_extras+ also needs to
+        # be monkey patched. See [1] for details.
+        #
+        # [1] https://github.com/rails/rails/commit/f6232a518bb7377948f339d2b0b25dc607e1e42a
+        class << (routes || Rails.application.routes)
+          def generate_extras(options, recall={})
+            super options, recall
+          rescue *ROUTING_ERRORS => e
+            begin
+              super options.merge(controller: 'scrivito/cms_dispatch'), recall
+            rescue *ROUTING_ERRORS
+              raise e
+            end
+          end
+        end
+      end
+
       class << self
-        def assign_parameters(routes, controller_path, action, parameters = {})
-          super routes, controller_path, action, parameters
+        def assign_parameters(routes, controller_path, *args)
+          super routes, controller_path, *args
         rescue *ROUTING_ERRORS => e
           begin
-            super routes, 'scrivito/cms_dispatch', action, parameters
+            super routes, 'scrivito/cms_dispatch', *args
           rescue *ROUTING_ERRORS
             raise e
           end

data/lib/scrivito/ui_config.rb

@@ -10,7 +10,6 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     {
       app_extension_tags:  app_extension_tags,
       editing_context:     editing_context_config,
-      session:             session_config,
       backend_endpoint:    Configuration.endpoint,
       tenant:              Configuration.tenant,
       i18n:                i18n_config,
@@ -34,10 +33,6 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
     }
   end
 
-  def session_config
-    Session.renew(SecureRandom.hex(8), editor)
-  end
-
   def workspace_config(workspace)
     {
       id: workspace.id,

data/lib/scrivito/workspace_selection_middleware.rb

@@ -18,12 +18,6 @@ class WorkspaceSelectionMiddleware
 
     @app.call(env)
   end
-
-  private
-
-  def session(env)
-    env[Rack::Session::Abstract::ENV_SESSION_KEY]
-  end
 end
 
 end # module Scrivito

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0.rc1
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: memoist
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +220,6 @@ files:
 - app/views/scrivito/users/publish_ability.json.jbuilder
 - app/views/scrivito/users/users.json.jbuilder
 - app/views/scrivito/webservice/_workspace.json.jbuilder
-- app/views/scrivito/webservice/empty.json
 - app/views/scrivito/webservice/error.json.jbuilder
 - app/views/scrivito/webservice/workspaces.json.jbuilder
 - app/views/scrivito/workspaces/check.json.jbuilder
@@ -235,8 +240,8 @@ files:
 - lib/assets/images/scrivito/source_too_large.png
 - lib/assets/images/scrivito/source_type_invalid.png
 - lib/assets/javascripts/scrivito.js
-- lib/assets/javascripts/scrivito_sdk.js
 - lib/assets/javascripts/scrivito_ui_redirect.js
+- lib/assets/javascripts/scrivito_with_js_sdk.js
 - lib/assets/stylesheets/scrivito.css
 - lib/generators/scrivito/install/install_generator.rb
 - lib/generators/scrivito/install/templates/app/controllers/cms_controller.rb
@@ -347,6 +352,7 @@ files:
 - lib/scrivito/image_tag.rb
 - lib/scrivito/integer_conversion.rb
 - lib/scrivito/layout_tags.rb
+- lib/scrivito/legacy_switch.rb
 - lib/scrivito/link.rb
 - lib/scrivito/link_parser.rb
 - lib/scrivito/log_subscriber.rb
@@ -387,7 +393,6 @@ files:
 - lib/scrivito/route.rb
 - lib/scrivito/routing_extensions.rb
 - lib/scrivito/sdk_engine.rb
-- lib/scrivito/session.rb
 - lib/scrivito/string_tagging.rb
 - lib/scrivito/tag_renderer.rb
 - lib/scrivito/task.rb
@@ -423,12 +428,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: SDK for the Scrivito CMS

data/app/views/scrivito/webservice/empty.json

@@ -1 +0,0 @@
-{}

data/lib/scrivito/session.rb

@@ -1,23 +0,0 @@
-module Scrivito
-class Session
-  def self.renew(id, user)
-    payload = {
-      session: {
-        role: 'editor',
-        user_id: user.id,
-        permissions: permissions(user),
-      },
-    }
-
-    CmsRestApi.task_unaware_request(:put, "sessions/#{id}", payload)
-  end
-
-  def self.permissions(user)
-    Hash[user.explicit_rules.map do |permission, verb, _, _|
-      [verb, permission.to_s]
-    end]
-  end
-
-  private_class_method :permissions
-end
-end