infopark_cloud_connector 7.0.2 → 7.1.0

data/lib/rails_connector/obj_search_enumerator.rb

@@ -108,6 +108,8 @@ module RailsConnector
   #
   # @api public
   class ObjSearchEnumerator
+    class UnregisteredObjFormat < StandardError; end
+
     include Enumerable
 
     attr_reader :query
@@ -145,6 +147,7 @@ module RailsConnector
               "Valid operators are: #{valid_boost_operators.join(', ')}"
         end
       end
+      @size = nil
       @query = (query || []) + [subquery]
 
       self
@@ -172,6 +175,7 @@ module RailsConnector
       end
       subquery = {:field => field, :operator => real_operator, :value => convert_value(value),
           :negate => true}
+      @size = nil
       @query = (query || []) + [subquery]
 
       self
@@ -221,6 +225,12 @@ module RailsConnector
       self
     end
 
+    def include_deleted
+      @include_deleted = true
+
+      self
+    end
+
     # @!endgroup
 
     # Iterates over the search result, yielding {BasicObj Obj}.
@@ -241,7 +251,7 @@ module RailsConnector
 
         offset += 1
         hit = current_batch.shift
-        yield Obj.find(hit['id'])
+        yield hit
       end
     end
 
@@ -249,7 +259,39 @@ module RailsConnector
     # @return [Integer]
     # @api public
     def size
-      @size ||= CmsRestApi.get(resource_path, {:query => query, :size => 0})['total'].to_i
+      return @size if @size
+
+      size_query = {
+        query: query,
+        size: 0
+      }
+      if @include_deleted
+        size_query[:options] = {
+          include_deleted: true
+        }
+      end
+
+      @size ||= CmsRestApi.get(resource_path, size_query)['total'].to_i
+    end
+
+    # load a single batch of search results from the backend.
+    # returns an array of Objs.
+    # will usually return `batch_size` results if available,
+    # but may occasionally return fewer than `batch_size` results (due to rate limit, for example).
+    # @api public
+    def load_batch
+      next_batch = fetch_next_batch(options[:offset] || 0)
+
+      formatter = @formatter || -> obj { obj.id }
+      next_batch.first.map { |obj| formatter.call(obj) }
+    end
+
+    def format(name)
+      if @formatter = Configuration.obj_formats[name]
+        self
+      else
+        raise UnregisteredObjFormat, "The format with name '#{name}' is not registered."
+      end
     end
 
     # @api public
@@ -300,7 +342,12 @@ module RailsConnector
     def fetch_next_batch(offset)
       request_result = CmsRestApi.get(resource_path, search_dsl(offset))
 
-      [request_result['results'], request_result['total'].to_i]
+      obj_ids = request_result['results'].map { |result| result['id'] }
+      objs = Obj.find_including_deleted(obj_ids)
+
+      @size = request_result['total'].to_i
+
+      [objs, @size]
     end
 
     def resource_path
@@ -309,13 +356,21 @@ module RailsConnector
 
     def search_dsl(offset)
       patches = {
-        :offset => offset,
-        :query => query,
+        offset: offset,
+        query: query,
       }
       if @reverse_order
         patches[:sort_order] = options[:sort_by].present? ? :desc : :asc
       end
+
+      if @include_deleted
+        patches[:options] = {
+          include_deleted: true
+        }
+      end
+
       options.merge(patches)
     end
+
   end
 end

data/lib/rails_connector/rate_limit_exceeded.rb

@@ -0,0 +1,5 @@
+module RailsConnector
+  class RateLimitExceeded < CommunicationError
+
+  end
+end

data/lib/rails_connector/revision.rb

@@ -0,0 +1,9 @@
+module RailsConnector
+
+class Revision < Struct.new(:id, :content_state, :workspace)
+  def initialize(options)
+    super(*options.values_at(:id, :content_state, :workspace))
+  end
+end
+
+end

data/lib/rails_connector/string_tagging.rb

@@ -4,26 +4,15 @@ module RailsConnector
   module StringTagging
 
     # html flavour
-    def self.tag_as_html(string, source)
+    def self.tag_as_html(string)
       unless string.blank?
         class << string
           include RailsConnector::HtmlString
         end
-        string.source = source
       end
       string
     end
 
-    # markdown flavour
-    def self.tag_as_markdown(string, source)
-      unless string.blank?
-        class << string
-          include RailsConnector::MarkdownString
-        end
-        string.source = source
-      end
-      string
-    end
   end
 
 end

data/lib/rails_connector/text_link.rb

@@ -0,0 +1,52 @@
+module RailsConnector
+
+class TextLink
+
+  def initialize(link_data)
+    @data = link_data
+  end
+
+  def query_and_fragment
+    query = @data["query"]
+    fragment = @data["fragment"]
+
+    str = ''
+    str << "?#{query}" if query.present?
+    str << "##{fragment}" if fragment.present?
+    str
+  end
+
+  def internal?
+    !url
+  end
+
+  def external_url
+    url =~ /(external:)?(.*)/
+    $2
+  end
+
+  def obj_id
+    @data["destination"]
+  end
+
+  def html_attribute_snippet
+    tag_name = @data["tag_name"]
+    title = @data["title"]
+    target = @data["target"]
+
+    parts = []
+    parts << %{alt="#{title}"} if tag_name == 'img' || tag_name == 'input'
+    parts << %{title="#{title}"} if (tag_name == 'a' || tag_name == 'link') && title.present?
+    parts << %{target="#{target}"} if target.present?
+    parts.join(' ')
+  end
+
+  private
+
+  def url
+    @data["url"]
+  end
+
+end
+
+end

data/lib/rails_connector/text_link_conversion.rb

@@ -0,0 +1,50 @@
+module RailsConnector
+
+class TextLinkConversion
+
+  def initialize(text_links)
+    @text_links = text_links
+  end
+
+  def convert(html)
+    return html unless @text_links
+
+    if html
+      html.gsub(%r{<?\binternallink:(\d+)\b>?(['"]?)}) do
+        link = @text_links[$1]
+        postfix = $2
+        if link
+          attach_snippet("#{convert_link(link)}#{postfix}", link)
+        else
+          "#__text_link_missing#{postfix}"
+        end
+      end
+    end
+  end
+
+  private
+
+  def convert_link(link)
+    link.internal? ? convert_internal_link(link) : convert_external_link(link)
+  end
+
+  def attach_snippet(text, link)
+    snippet = link.html_attribute_snippet
+    if snippet.present?
+      "#{text} #{snippet}"
+    else
+      text
+    end
+  end
+
+  def convert_internal_link(link)
+    "objid:#{link.obj_id}#{link.query_and_fragment}"
+  end
+
+  def convert_external_link(link)
+    link.external_url
+  end
+
+end
+
+end

data/lib/rails_connector/workspace.rb

@@ -1,14 +1,26 @@
 module RailsConnector
 
+# This class represents a CMS workspace
+# @api public
 class Workspace
   extend ActiveModel::Naming
 
   include ModelIdentity
 
-  def self.current=(workspace_or_proc)
-    @current = workspace_or_proc
+  # Set the currently used workspace
+  # @api public
+  # @param [RailsConnector::Workspace] workspace
+  def self.current=(workspace)
+    @current = workspace
   end
 
+  def self.current_using_proc=(workspace_proc)
+    @current = workspace_proc
+  end
+
+  # Returns the currently used workspace
+  # @api public
+  # @return [RailsConnector::Workspace]
   def self.current
     if @current.respond_to? :call
       @current = @current.call
@@ -17,22 +29,103 @@ class Workspace
     end
   end
 
+  # Returns all the workspaces
+  # @api public
+  # @return [Array<RailsConnector::Workspace>]
+  def self.all
+    result_json = CmsRestApi.get('/workspaces')
+
+    result_json['results'].map do |workspace_json|
+      Workspace.find(workspace_json['id'])
+    end
+  end
+
   def self.default
     find("published")
   end
 
+  # Find a workspace by its id
+  # @api public
+  # @param [String] id
+  # @return [RailsConnector::Workspace]
+  # @raise [RailsConnector::ResourceNotFound]
   def self.find(id)
-    if workspace_data = CmsBackend.find_workspace_data_by_id(id)
+    if workspace_data = CmsBackend.instance.find_workspace_data_by_id(id)
       Workspace.new workspace_data
     else
       raise ResourceNotFound, "Could not find #{self} with id #{id}"
     end
   end
 
+  delegate :content_state, :base_revision_id, :base_content_state, to: :data
+
+  # Create a new workspace
+  # @api public
+  # @param [Hash] attributes
+  # @return [RailsConnector::Workspace]
+  def self.create(attributes)
+    workspace_json = CmsRestApi.post("/workspaces", workspace: attributes)
+
+    self.find(workspace_json["id"])
+  end
+
+  # reloads the current workspace to reflect any changes to it that may have happened concurrently
+  # since it was loaded
+  # @api public
+  def self.reload
+    id = current.id
+    self.current_using_proc = proc { find(id) }
+  end
+
   def initialize(workspace_data)
     @workspace_data = workspace_data
   end
 
+  # Reloads this workspace to reflect any changes to it that may have happened concurrently since
+  # it was loaded
+  # @api public
+  def reload
+    @workspace_data = CmsBackend.instance.find_workspace_data_by_id(self.id)
+    @revision = @base_revision = nil
+  end
+
+  # Updates this workspace's attributes
+  # @api public
+  # @param [Hash] attributes
+  # @return [RailsConnector::Workspace]
+  def update(attributes)
+    CmsRestApi.put(backend_url, workspace: attributes)
+
+    self.reload
+  end
+
+  # Destroy this workspace
+  # @api public
+  def destroy
+    CmsRestApi.delete(backend_url)
+
+    reset_workspace_if_current
+  end
+
+  # Publish the changes of this workspace
+  # @api public
+  def publish
+    CmsRestApi.put("#{backend_url}/publish", {})
+
+    reset_workspace_if_current
+  end
+
+  # Rebases the current workspace on the published content
+  # @api public
+  def rebase
+    CmsRestApi.put("#{backend_url}/rebase", {})
+
+    self.reload
+  end
+
+  # Returns the id of the workspace
+  # @api public
+  # @return [String]
   def id
     @workspace_data.id
   end
@@ -41,6 +134,9 @@ class Workspace
     @workspace_data.revision_id
   end
 
+  # Returns the title of the workspace
+  # @api public
+  # @return [String]
   def title
     @workspace_data.title
   end
@@ -53,6 +149,14 @@ class Workspace
     self.id == 'published'
   end
 
+  def revision
+    @revision ||= Revision.new(id: revision_id, content_state: content_state, workspace: self)
+  end
+
+  def base_revision
+    @base_revision ||= Revision.new(id: base_revision_id, content_state: base_content_state)
+  end
+
   def as_current(&block)
     old_workspace = Workspace.current
 
@@ -65,6 +169,24 @@ class Workspace
     end
   end
 
+  def raise_if_reverting_objs_impossible
+    raise "cannot revert changes, since workspace is not modifiable" if published?
+    raise "cannot revert changes, since workspace may contain attribute "\
+        "and class changes (rtc)" if id == 'rtc'
+  end
+
+  private
+
+  def backend_url
+    "/workspaces/#{id}"
+  end
+
+  def reset_workspace_if_current
+    if Workspace.current == self
+      Workspace.current = Workspace.default
+    end
+  end
+
 end
 
 end