scrivito_sdk 0.12.0

data/lib/scrivito/communication_error.rb

@@ -0,0 +1,17 @@
+module Scrivito
+
+  class CommunicationError < StandardError
+    attr_reader :http_code, :message
+
+    def initialize(message, http_code)
+      @http_code = http_code.to_i
+      @message = message
+    end
+
+    def to_s
+      "HTTP-Response-Code: #{self.http_code}, Body: \"#{self.message}\""
+    end
+
+  end
+
+end

data/lib/scrivito/comparison.rb

@@ -0,0 +1,67 @@
+module Scrivito
+
+class Comparison < Struct.new(:revision, :inverse, :diff_mode)
+
+  alias :inverse? :inverse
+
+  def active?
+    !!revision
+  end
+
+  def modification(content)
+    return nil unless revision
+
+    convert_modification(content.modification(revision))
+  end
+
+  def modification_for_attribute(content, field_name)
+    return nil unless revision
+
+    convert_modification(
+      content.modification_for_attribute(field_name, revision)
+    )
+  end
+
+  def diff_for(content, field_name)
+    return nil unless revision
+
+    current_value = content[field_name]
+    compare_value = value_of(content, field_name)
+
+    return nil if current_value == compare_value
+
+    field_type = content.type_of_attribute(field_name)
+
+    if inverse?
+      old, new = current_value, compare_value
+    else
+      old, new = compare_value, current_value
+    end
+
+    Scrivito::Diff.for(diff_mode, field_type, old, new)
+  end
+
+  private
+
+  def value_of(content, field_name)
+    compare_content = content.in_revision(revision)
+    compare_content && compare_content[field_name]
+  end
+
+  def convert_modification(modification)
+    if inverse?
+      case modification
+      when Modification::NEW
+        Modification::DELETED
+      when Modification::DELETED
+        Modification::NEW
+      else
+        modification
+      end
+    else
+      modification
+    end
+  end
+end
+
+end

data/lib/scrivito/configuration.rb

@@ -0,0 +1,221 @@
+require 'scrivito/blob'
+
+module Scrivito
+  #
+  # Configures the Scrivito SDK.
+  # The configuration keys +tenant+ and +api_key+ _must_ be provided.
+  #
+  # @example
+  #   Scrivito.configure do |config|
+  #     config.tenant  = 'my-tenant-name'
+  #     config.api_key = 'secret'
+  #   end
+  #
+  # @api public
+  #
+  def self.configure
+    yield ::Scrivito::Configuration
+  end
+
+  #
+  # @api public
+  #
+  class Configuration
+    #
+    # Default path of a CA certification file in PEM format.
+    #
+    # @api public
+    #
+    DEFAULT_CA_FILE = File.expand_path('../../../config/ca-bundle.crt', __FILE__)
+
+    class << self
+      # Determine if current visitor is permitted to edit content.
+      attr_accessor :editing_auth_callback
+
+      # Configure a callback to be invoked when the Scrivito SDK determines,
+      # if current visitor is permitted to edit content.
+      # Default is <code>false</code>.
+      #
+      # Example Usage:
+      #     Scrivito::Configuation.editing_auth do |env|
+      #       request = Rack::Request.new(env)
+      #       # return truey if current visitor is permitted to edit content, falsy otherwise
+      #     end
+      # @api public
+      def editing_auth(&block)
+        if block.respond_to?(:arity) && block.arity == 1
+          self.editing_auth_callback = block
+        else
+          raise ArgumentError, 'editing_auth should have only one attribute!'
+        end
+      end
+
+      # TODO: Legacy compatiblity. Remove when DisplayHelper gets removed.
+      def editor_interface_enabled?
+        false
+      end
+
+      # The +Scrivito+ makes heavy use of filesystem caching.
+      # Use this method to configure the directory that should be used to store cached data.
+      # By default, +RAILS_ROOT/tmp/scrivito_cache+ will be used.
+      # @param path [String] Path to directory that should be used to store cached data.
+      # @example Configure +Scrivito+ to store its cache under +/tmp/my_cache+.
+      #     Scrivito::Configuration.cache_path = '/tmp/my_cache'
+      # @api public
+      def cache_path=(path)
+        CmsCacheStorage.backend_cache = ActiveSupport::Cache::FileStore.new(path)
+      end
+
+      #
+      # Sets the tenant name.
+      # This configuration key _must_ be provided.
+      #
+      # @api public
+      #
+      def tenant=(tenant_name)
+        @endpoint_uri = nil
+        @tenant = tenant_name
+      end
+
+      #
+      # Sets the API key.
+      # This configuration key _must_ be provided.
+      #
+      # @api public
+      #
+      attr_writer :api_key
+
+      #
+      # Sets the API endpoint URL.
+      # This configuration key is optional.
+      # Default is +'api.scrival.com'+.
+      # If no schema is provided HTTPS is assumed.
+      #
+      # @api public
+      #
+      attr_writer :endpoint
+
+      #
+      # Gets the path of a CA certification file in PEM format.
+      #
+      # @return [String]
+      # @api public
+      #
+      attr_reader :ca_file
+
+      # Sets path of a CA certification file in PEM format.
+      # The file can contain several CA certificates.
+      # Certifications will be used for endpoint peer verification of various scrivito services
+      # e.g. Content Read Service.
+      # @api public
+      def ca_file=(path)
+        File.read(path) if path # Try to read the given file and fail if it doesn't exist or is not readable.
+        @ca_file = path
+      end
+
+      def to_prepare
+        unless Rails.configuration.cache_classes
+          NamedLink.reset_cache
+          BasicObj.reset_type_computer!
+          BasicWidget.reset_type_computer!
+          ::ApplicationController.__send__(:helper, :cms)
+        end
+      end
+
+      def configure_cms_database
+      end
+
+      def tenant
+        assert_key_present(:tenant)
+        @tenant
+      end
+
+      def api_key
+        assert_key_present(:api_key)
+        @api_key
+      end
+
+      def endpoint
+        assert_key_present(:endpoint)
+        @endpoint
+      end
+
+      def endpoint_uri
+        @endpoint_uri ||= calculate_endpoint_uri
+      end
+
+      def set_defaults!
+        self.ca_file = DEFAULT_CA_FILE
+        self.editing_auth { |env| false }
+        self.endpoint = 'api.scrival.com'
+      end
+
+      attr_accessor :choose_homepage_callback
+
+      # Configure a callback to be invoked when the Scrivito SDK delivers the homepage.
+      # The given callback will receive the rack env
+      # and must return an {BasicObj Obj} to be used as the homepage.
+      # If no callback is configured, {BasicObj.homepage Obj.homepage} will be used as the default.
+      # @api public
+      def choose_homepage(&block)
+        self.choose_homepage_callback = block
+      end
+
+      def cms_routes(*args)
+        raise <<-EOS.gsub(/\s+/, ' ')
+        Calling Scrivito::Configuration.cms_routes is not needed anymore.
+        Please remove it from config/routes.rb
+        EOS
+      end
+
+      def use_x_sendfile=(value)
+        raise 'Configuration.use_x_sendfile is now available as Rails configuration:'\
+              ' config.action_dispatch.x_sendfile_header = "X-Sendfile"'
+      end
+
+      def obj_formats
+        @obj_formats ||= {
+          '_changes_list' => proc do |obj|
+            {
+              id: obj.id,
+              obj_class_name: obj.obj_class_name,
+              description_for_editor: obj.description_for_editor,
+              modification: obj.modification,
+              has_conflict: obj.has_conflict?,
+              last_changed: obj.last_changed.utc.iso8601,
+              is_binary: obj.binary?,
+            }
+          end
+        }
+      end
+
+      def register_obj_format(name, &block)
+        if name.start_with? '_'
+          raise InvalidFormatNameError.new('Format names starting with underscore are not allowed.')
+        else
+          obj_formats[name] = block
+        end
+      end
+
+      private
+
+      def assert_key_present(key)
+        if instance_variable_get("@#{key}").nil?
+          raise "Missing required configuration key '#{key}'."
+        end
+      end
+
+      def calculate_endpoint_uri
+        url = endpoint
+        url = "https://#{url}" unless url.match(/^http/)
+        url = "#{url}/tenants/#{tenant}"
+        URI.parse(url)
+      end
+    end
+
+    self.set_defaults!
+  end
+
+  class InvalidFormatNameError < StandardError
+  end
+end

data/lib/scrivito/connection_manager.rb

@@ -0,0 +1,100 @@
+module Scrivito
+  class ConnectionManager
+    SOCKET_ERRORS = [
+      EOFError,
+      Errno::ECONNABORTED,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EINVAL,
+      Errno::EPIPE,
+      Errno::ETIMEDOUT,
+      IOError,
+      SocketError,
+      Timeout::Error,
+    ].freeze
+
+    DEFAULT_TIMEOUT = 10.freeze
+
+    attr_reader :uri
+
+    class << self
+      def instance
+        @instance ||= new(Configuration.endpoint_uri)
+      end
+
+      # For test purpose only.
+      def reset_instance!
+        @instance = nil
+      end
+    end
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def request(request, timeout=DEFAULT_TIMEOUT)
+      request['User-Agent'] = user_agent
+      ensure_started(timeout)
+
+      begin
+        connection.request(request)
+      rescue *SOCKET_ERRORS => e
+        ensure_finished
+        raise NetworkError.from_socket_error(e)
+      end
+    end
+
+    private
+
+    attr_accessor :connection
+
+    def ensure_started(timeout)
+      if @connection && @connection.started?
+        configure_timeout(@connection, timeout)
+      else
+        conn = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+          conn.use_ssl = true
+          conn.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          conn.ca_file = Scrivito::Configuration.ca_file
+        end
+        configure_timeout(conn, timeout)
+        retry_twice_on_socket_error do
+          conn.start
+        end
+        @connection = conn
+      end
+    end
+
+    def ensure_finished
+      @connection.finish if @connection && @connection.started?
+      @connection = nil
+    end
+
+    def retry_twice_on_socket_error
+      attempt = 0
+      begin
+        yield
+      rescue *SOCKET_ERRORS => e
+        raise NetworkError.from_socket_error(e) if attempt == 2
+        attempt += 1
+        retry
+      end
+    end
+
+    def configure_timeout(connection, timeout)
+      connection.open_timeout = timeout
+      connection.read_timeout = timeout
+      connection.ssl_timeout = timeout
+    end
+
+    def user_agent
+      @user_agent ||= (
+        gem_info = Gem.loaded_specs["scrivito_sdk"]
+        if gem_info
+          "#{gem_info.name}-#{gem_info.version}"
+        end
+      )
+    end
+  end
+end

data/lib/scrivito/content_conversion.rb

@@ -0,0 +1,43 @@
+require 'nokogiri'
+
+module Scrivito
+
+  class ContentConversion
+    def self.convert_html_links(input, request_host, request_port)
+      doc = Nokogiri::HTML.parse("<div class='internal_jump_point'>#{input}</div>")
+
+      doc.css('body a').each do |a_tag|
+        if href = a_tag.attributes['href']
+          link = Link.parse(href.value, request_host, request_port)
+          href.value = link.to_cms_api_html_url
+        end
+      end
+
+      doc.css('body img').each do |img_tag|
+        if src = img_tag.attributes['src']
+          link = Link.parse(src.value, request_host, request_port)
+          src.value = link.to_cms_api_html_url
+        end
+      end
+
+      new_html = doc.css('body div.internal_jump_point').inner_html
+
+      nbsp = Nokogiri::HTML("&nbsp;").text
+      new_html.gsub(nbsp, "&nbsp;")
+    end
+
+    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
+
+        link_data
+      end
+    end
+  end
+
+end