scrivito_sdk 1.0.0 → 1.1.0.rc1

data/lib/scrivito/routing_extensions.rb

@@ -0,0 +1,92 @@
+module Scrivito
+
+# @api public
+module RoutingExtensions
+
+  # @api public
+  #
+  #+scrivito_route+ defines routes for Scrivito pages. The default routes are:
+  #
+  #   scrivito_route '(/)(*slug-):id', using: 'slug_id', via: :all
+  #   scrivito_route '/', using: 'homepage', via: :all
+  #   scrivito_route '/*permalink', using: 'permalink', format: false, via: :all
+  #
+  # The first parameter of +scrivito_route+ should look familiar - it is just a regular
+  # Rails route pattern. You can make full use of the Rails route patterns when specifying
+  # Scrivito routes.
+  #
+  # In addition to directing incoming traffic to the code that handles it, Scrivito
+  # routes have another distinct functionality: They determine which URL or path is generated
+  # for a given CMS object. The +using:+ option needs to be provided to tell Scrivito which
+  # route should be used for which type of CMS objects.  For example, <code>using:
+  # "permalink"</code> instructs Scrivito to use the route for CMS objects to which a
+  # +_permalink+ has been assigned. The Scrivito routes expect the route pattern to contain
+  # route parameters for dynamically inserting the values for individual CMS objects. If,
+  # for example, the permalink of an object is +about+ and the route pattern is
+  # +my_page/*permalink+, Scrivito generates the url +http://www.example.com/my_page/about+.
+  # Valid +:using+ values and their required route parameters are:
+  #
+  # [+slug_id+] Route pattern for a normal CMS object. Expected route parameters are +slug+
+  #             and +id+.
+  # [+homepage+] Route pattern for a homepage CMS object. No route parameters needed.
+  # [+permalink+] Route pattern for CMS objects that have a +_permalink+ assigned to them. The
+  #               required route parameter is +permalink+.
+  #
+  # @example Route that starts with the object ID
+  #   scrivito_route '(/):id(/*slug)', using: 'slug_id', via: [:get, :post]
+  #
+  # @example Scoped permalink with disabled format
+  #   scrivito_route '/pl/*permalink', using: 'permalink', format: false
+  #
+  # @param path [String] a Rails route pattern
+  # @param using [String] The name of the route. Valid values are +slug_id+, +homepage+, and
+  #   +permalink+.
+  # @param format [Boolean] Use +format+ +true+ or +false+ to enforce or disable the format.
+  # @param via [Symbol] Use to specify for which HTTP verbs the route should match. +:get+ is
+  #   the default. Use +:all+ to allow every verb.
+  #
+  # @note To use +scrivito_route+ {Scrivito::Configuration.inject_preset_routes} needs to be
+  #   disabled.
+  def scrivito_route(path, using:, format: nil, via: :get)
+    assert_scrivito_route_enabled
+    # @set is a ActionDispatch::Routing::RouteSet
+    # see: http://git.io/v4UYF and http://git.io/v4UOI
+    route_set = @set
+
+    route_name = using.to_sym
+
+    route = Route.register(route_set, route_name)
+
+    options = {
+      to: 'scrivito/cms_dispatch#index',
+      via: via,
+      format: format,
+      as: route.helper_name,
+    }
+
+    options[:constraints] = {id: /[a-z0-9]{16}/} if route_name == :slug_id
+
+    begin
+      match(path, options)
+    rescue ArgumentError => error
+      if error.message.include?(route.helper_name)
+        raise ScrivitoError,
+            %(You have already defined a Scrivito route with the name "#{route_name}".)
+      else
+        raise error
+      end
+    end
+  end
+
+  private
+
+  def assert_scrivito_route_enabled
+    unless Scrivito::Configuration.scrivito_route_enabled?
+      raise ScrivitoError, 'The preset routes are still enabled. Please disable them by ' \
+        'setting the configuration "inject_preset_routes" to false before using scrivito_route'
+    end
+  end
+
+end
+
+end

data/lib/scrivito/sdk_engine.rb

@@ -39,6 +39,10 @@ module ::Scrivito
       end
     end
 
+    initializer "scrivito.routing_extensions" do
+      ActionDispatch::Routing::Mapper.__send__(:include, Scrivito::RoutingExtensions)
+    end
+
     initializer 'scrivito.add_sdk_assets' do |app|
       # Specify which file should be precompiled for packaging
       app.config.assets.precompile += %w[

data/lib/scrivito/task.rb

@@ -0,0 +1,77 @@
+module Scrivito
+  class Task
+    def self.find(id)
+      new(id: id)
+    end
+
+    attr_reader :id
+
+    def initialize(params = nil)
+      return update(params) if params
+
+      response = yield
+      if params = extract_params(response)
+        update(params)
+      else
+        update(status: 'success', result: response)
+      end
+    rescue ClientError => e
+      update(status: 'error', message: e.message, code: e.backend_code)
+    end
+
+    def open?
+      @status == 'open'
+    end
+
+    def success?
+      @status == 'success'
+    end
+
+    def error?
+      @status == 'error'
+    end
+
+    def result
+      case
+      when success? then @result
+      when error?   then raise ClientError.new(@message, 400, @code)
+      else
+        poll
+        result
+      end
+    end
+
+    private
+
+    def extract_params(response)
+      if response.is_a?(Hash) && response.keys == ['task'] && response['task'].is_a?(Hash)
+        response['task']
+      end
+    end
+
+    def reload
+      task_data = CmsRestApi.task_unaware_request(:get, "tasks/#{@id}")
+      update(task_data)
+    end
+
+    def update(task_data)
+      task_data = task_data.with_indifferent_access
+
+      @id      = task_data[:id]      if task_data[:id]
+      @status  = task_data[:status]  if task_data[:status]
+      @result  = task_data[:result]  if task_data[:result]
+      @message = task_data[:message] if task_data[:message]
+      @code    = task_data[:code]    if task_data[:code]
+
+      reload unless @status
+    end
+
+    def poll
+      loop do
+        sleep 2
+        reload
+        break unless open?
+      end
+    end
+  end
+end

data/lib/scrivito/type_computer.rb

@@ -9,11 +9,11 @@ class TypeComputer
    load_class(obj_class) || @fallback_class
   end
 
-  def compute_type_without_fallback(obj_class)
-    if obj_class = load_class(obj_class)
+  def compute_type_without_fallback(obj_class_name)
+    if obj_class = load_class(obj_class_name)
       obj_class
     else
-      raise ObjClassNotFound
+      raise ObjClassNotFound, obj_class_name
     end
   end
 

data/lib/scrivito/ui_config.rb

@@ -57,6 +57,10 @@ class UiConfig < Struct.new(:editing_context, :resource, :return_to, :app_extens
   def user_permissions_config
     {
       create_workspace: editor.can?(:create, :workspace),
+      rename_workspace: editor.can?(:write, selected_workspace),
+      invite_to_workspace: editor.can?(:invite_to, selected_workspace),
+      rebase_workspace: editor.can?(:write, selected_workspace),
+      delete_workspace: editor.can?(:delete, selected_workspace),
       publish_workspace: editor.can?(:publish, selected_workspace),
     }
   end

data/lib/scrivito/user.rb

@@ -8,12 +8,24 @@ module Scrivito
     # @api public
     #
     VERBS = [
+      # Lets the user create new working copies.
       :create,
+
+      # Makes the content of the working copy visible to the user.
+      :read,
+
+      # Lets the user modify the content of the working copy.
+      # Also lets the user rename the working copy.
+      :write,
+
+      # Permits the user to delete the working copy.
       :delete,
+
+      # Permits the user to invite other users to collaborate on the working copy.
       :invite_to,
+
+      # Permits the user to publish the working copy.
       :publish,
-      :read,
-      :write,
     ].freeze
 
     class << self
@@ -105,6 +117,7 @@ module Scrivito
       end
 
       def assert_valid_id(id)
+        raise ScrivitoError.new('User id must be a string') unless id.to_s == id
         raise ScrivitoError.new('User id can not be blank') if id.blank?
         raise ScrivitoError.new('User id is too long (max length 64)') if id.length > 64
       end
@@ -130,10 +143,15 @@ module Scrivito
 
     def can?(verb, workspace)
       assert_valid_verb(verb)
-      can_always?(verb, :workspace) ||
-        verb == :create && can_create? ||
-        verb == :read && can_read?(workspace) ||
-        can_as_owner?(verb, workspace)
+
+      return true if can_always?(verb, :workspace)
+      return false if can_never?(verb, :workspace)
+
+      case verb
+      when :create                               then true
+      when :read                                 then workspace.published? || owner_of?(workspace)
+      when :write, :delete, :invite_to, :publish then owner_of?(workspace)
+      end
     end
 
     def can_always?(verb, subject)
@@ -207,18 +225,6 @@ module Scrivito
 
     private
 
-    def can_create?
-      !can_never?(:create, :workspace)
-    end
-
-    def can_read?(workspace)
-      workspace.published? || can_as_owner?(:read, workspace)
-    end
-
-    def can_as_owner?(verb, workspace)
-      workspace.is_a?(Workspace) && owner_of?(workspace) && !can_never?(verb, :workspace)
-    end
-
     def calculate_description
       description_proc ? description_proc.call : id
     end

data/lib/scrivito/workspace/publish_checker.rb

@@ -11,8 +11,7 @@ module Scrivito
 
           return false unless responses.all? do |response|
             raise_invalid_certificates_error if response[:content_state_id].nil?
-
-            response[:content_state_id] == workspace.content_state.content_state_id
+            response[:content_state_id] == workspace.content_state_id
           end
 
           assert_passing_result(responses)
@@ -51,7 +50,7 @@ module Scrivito
 
         pass_sub_hash = {
           workspace_id: workspace.id,
-          content_state_id: workspace.content_state.content_state_id,
+          content_state_id: workspace.content_state_id,
           from: offset,
           until: until_element,
         }

data/lib/scrivito/workspace.rb

@@ -136,9 +136,13 @@ class Workspace
   # @param [Hash] attributes
   # @return [Scrivito::Workspace]
   def self.create(attributes)
-    workspace_json = CmsRestApi.post("/workspaces", workspace: attributes)
+    find(create_async(attributes).result['id'])
+  end
 
-    self.find(workspace_json["id"])
+  def self.create_async(attributes)
+    Task.new do
+      CmsRestApi.task_unaware_request(:post, 'workspaces', workspace: attributes)
+    end
   end
 
   # Reloads the current workspace to reflect the changes that were made to it concurrently
@@ -148,6 +152,23 @@ class Workspace
     current.reload
   end
 
+  # @api public
+  #
+  # This method provides a string that can be used as part of a cache key. It changes
+  # whenever any content ({Scrivito::BasicObj Obj} or {Scrivito::BasicWidget Widget})
+  # changes. Due to this, caches using the +cache_key+ are invalidated whenever
+  # a CMS object in the working copy has been changed.
+  #
+  # Scrivito provides the {ScrivitoHelper#scrivito_cache scrivito_cache} method which
+  # integrates the +cache_key+ with Rails' fragment caching. You might want to check whether
+  # +scrivito_cache+ satisfies your needs before implementing your own solution.
+  #
+  # @return [String] A string that changes whenever the content of the working copy
+  #   changes.
+  def cache_key
+    @cache_key ||= Digest::SHA1.hexdigest("#{id}|#{content_state_id}")
+  end
+
   def self.cache
     @cache ||= {}
   end
@@ -206,21 +227,31 @@ class Workspace
   # Publish the changes that were made to this workspace.
   # @api public
   def publish
-    CmsRestApi.put("#{backend_url}/publish", {})
-
+    publish_async.result
     Workspace.published.reload
-
     reset_workspace_if_current
   end
 
+  def publish_async
+    Task.new do
+      task_unaware_api_request(:put, '/publish')
+    end
+  end
+
   # Rebases the current workspace from the published content in order to integrate the changes
   # that were published in the meantime.
   # @api public
   def rebase
-    CmsRestApi.put("#{backend_url}/rebase", {})
+    rebase_async.result
     reload
   end
 
+  def rebase_async
+    Task.new do
+      task_unaware_api_request(:put, '/rebase')
+    end
+  end
+
   # Returns the id of the workspace.
   # @api public
   # @return [String]
@@ -341,6 +372,7 @@ class Workspace
     @base_revision = nil
     @memberships   = nil
     @revision      = nil
+    @cache_key     = nil
   end
 
   def fetch_workspace_data

data/lib/scrivito/workspace_data.rb

@@ -36,20 +36,6 @@ module Scrivito
       assert_no_obj_classes
     end
 
-    def store_in_cache
-      CmsDataCache.write_workspace_data(id, to_hash)
-    end
-
-    def content_state
-      @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
-    end
-
-    def base_content_state
-      if base_content_state_id
-        @base_content_state ||= ContentState.find_or_create(base_content_state_id)
-      end
-    end
-
     private
 
     def assert_no_obj_classes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.rc1
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -162,6 +162,7 @@ files:
 - app/controllers/scrivito/blobs_controller.rb
 - app/controllers/scrivito/completion_controller.rb
 - app/controllers/scrivito/default_cms_controller.rb
+- app/controllers/scrivito/legacy_redirect_controller.rb
 - app/controllers/scrivito/objs_controller.rb
 - app/controllers/scrivito/tasks_controller.rb
 - app/controllers/scrivito/ui_controller.rb
@@ -178,6 +179,7 @@ files:
 - app/views/scrivito/completion/suggest.json.jbuilder
 - app/views/scrivito/content_widget/show.html.erb
 - app/views/scrivito/fallback_thumbnail.html.erb
+- app/views/scrivito/objs/binary_no_cache.json.jbuilder
 - app/views/scrivito/objs/destroy.json.jbuilder
 - app/views/scrivito/objs/is_outdated.json.jbuilder
 - app/views/scrivito/objs/obj.json.jbuilder
@@ -266,6 +268,7 @@ files:
 - lib/scrivito/attribute_definition_collection.rb
 - lib/scrivito/attribute_deserializer.rb
 - lib/scrivito/attribute_serializer.rb
+- lib/scrivito/attribute_value_renderer.rb
 - lib/scrivito/backend/content_state_node.rb
 - lib/scrivito/backend/index.rb
 - lib/scrivito/backend/obj_data_cache.rb
@@ -308,10 +311,6 @@ files:
 - lib/scrivito/configuration.rb
 - lib/scrivito/connection_manager.rb
 - lib/scrivito/content_conversion.rb
-- lib/scrivito/content_service.rb
-- lib/scrivito/content_state.rb
-- lib/scrivito/content_state_caching.rb
-- lib/scrivito/content_state_visitor.rb
 - lib/scrivito/controller_actions.rb
 - lib/scrivito/controller_helper.rb
 - lib/scrivito/controller_runtime.rb
@@ -350,21 +349,27 @@ files:
 - lib/scrivito/obj_create_params_parser.rb
 - lib/scrivito/obj_data.rb
 - lib/scrivito/obj_data_from_hash.rb
-- lib/scrivito/obj_data_from_service.rb
 - lib/scrivito/obj_facet_value.rb
 - lib/scrivito/obj_params_parser.rb
 - lib/scrivito/obj_search_builder.rb
 - lib/scrivito/obj_search_enumerator.rb
+- lib/scrivito/obj_search_enumerator/batch.rb
+- lib/scrivito/obj_search_enumerator/batch_iterator.rb
+- lib/scrivito/obj_search_enumerator/query_executor.rb
 - lib/scrivito/obj_update_params_parser.rb
 - lib/scrivito/page_config.rb
 - lib/scrivito/parent_path.rb
+- lib/scrivito/preset_routes.rb
 - lib/scrivito/rate_limit_exceeded.rb
 - lib/scrivito/request_homepage.rb
 - lib/scrivito/restriction_set.rb
 - lib/scrivito/revision.rb
+- lib/scrivito/route.rb
+- lib/scrivito/routing_extensions.rb
 - lib/scrivito/sdk_engine.rb
 - lib/scrivito/string_tagging.rb
 - lib/scrivito/tag_renderer.rb
+- lib/scrivito/task.rb
 - lib/scrivito/test_request.rb
 - lib/scrivito/text_link.rb
 - lib/scrivito/text_link_conversion.rb
@@ -380,7 +385,6 @@ files:
 - lib/scrivito/workspace.rb
 - lib/scrivito/workspace/publish_checker.rb
 - lib/scrivito/workspace_data.rb
-- lib/scrivito/workspace_data_from_service.rb
 - lib/scrivito/workspace_selection_middleware.rb
 - lib/scrivito_sdk.rb
 - lib/tasks/cache.rake
@@ -401,9 +405,9 @@ 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

data/lib/scrivito/content_service.rb

@@ -1,121 +0,0 @@
-require 'timeout'
-require 'net/http'
-
-module Scrivito
-class ContentService
-  class RateLimitExceeded < StandardError
-    def initialize(retry_after)
-      @retry_after = retry_after
-    end
-
-    attr_reader :retry_after
-  end
-
-  class MaxSleepTimeReached < StandardError
-  end
-
-  class Delay
-    def initialize
-      @sleep_count = 0
-      @total_sleep_time = 0
-    end
-
-    def next_sleep_time(min_sleep = 0)
-      sleep_time = [2 ** @sleep_count * 0.5, min_sleep.to_f].max
-      @total_sleep_time += sleep_time
-      raise MaxSleepTimeReached if @total_sleep_time > 40
-      @sleep_count += 1
-      sleep_time
-    end
-  end
-
-  class << self
-    @next_request_not_before = nil
-
-    def query(path, payload, options={})
-      timeout = options.fetch(:timeout, ConnectionManager::DEFAULT_TIMEOUT)
-      retry_until_timeout_on_rate_limit_exceeded do
-        request = build_request(path, payload)
-        if @next_request_not_before && @next_request_not_before > (now = Time.now)
-          sleep @next_request_not_before - now
-        end
-
-        response = nil
-        retry_once_on_network_error do
-          response = connection_manager.request(request, timeout)
-        end
-        handle_response(response)
-      end
-    end
-
-    # for tests only
-    def forget_retry_after
-      @next_request_not_before = nil
-    end
-
-    def connection_manager
-      ConnectionManager.instance
-    end
-
-    private
-
-    def retry_once_on_network_error
-      retried = false
-      begin
-        yield
-      rescue NetworkError => e
-        raise e if retried
-        retried = true
-        retry
-      end
-    end
-
-    def retry_until_timeout_on_rate_limit_exceeded
-      delay = Delay.new
-      begin
-        yield
-      rescue RateLimitExceeded => e
-        begin
-          sleep delay.next_sleep_time(e.retry_after)
-        rescue MaxSleepTimeReached
-          raise ::Scrivito::RateLimitExceeded.new('rate limit exceeded', 429)
-        end
-        retry
-      end
-    end
-
-    def build_request(path, payload)
-      url = "#{Configuration.endpoint_uri.path}/#{path}".squeeze('/')
-      request = Net::HTTP::Post.new(url, request_headers)
-      request.basic_auth('api_token', Configuration.api_key)
-      request.body = MultiJson.dump(payload)
-      request
-    end
-
-    def handle_response(response)
-      case code = response.code
-      when /^2/
-        retry_after = response['Retry-After']
-        @next_request_not_before = retry_after ? Time.now + retry_after.to_f : nil
-        MultiJson.load(response.body)
-      when '429' then raise RateLimitExceeded.new(response['Retry-After'])
-      when '403' then raise AccessDenied.new(response.body)
-      when '401', '404'
-        raise NetworkError.new(
-          'There was a problem communicating with the Scrivito backend. '\
-          'Check your configuration, i.e. "tenant" and "api_key".', code)
-      else
-        raise NetworkError.new("Server responded with status code #{code}", code)
-      end
-    end
-
-    def request_headers
-      {
-        'Accept'       => 'application/json',
-        'Content-Type' => 'application/json',
-      }
-    end
-  end
-
-end
-end