infopark_cloud_connector 6.8.0.110.6570b45 → 6.8.0.210.ed204b0

data/app/helpers/rails_connector/marker_helper.rb

@@ -0,0 +1,46 @@
+module RailsConnector
+
+  module MarkerHelper # :nodoc:
+
+    def edit_marker(obj, attr, options = {}, &block)
+      if Configuration.editor_interface_enabled?
+        default_value = options.delete(:default_value)
+
+        if block_given?
+          content = block.call(obj, attr)
+          content = default_value || raw(" ") if content.blank?
+        end
+
+        tag_type = options.delete(:tag) || :span
+        content_tag(
+          tag_type,
+          content.to_s,
+          options
+        )
+      else
+        block_given? ? block.call(obj, attr) : nil
+      end
+    end
+
+    def marker_menu(left=0, top=0, &block)
+    end
+
+    def marker_menu_target(tag_name, options = {}, &block)
+      content_tag(
+        tag_name,
+        capture(&block),
+        options
+      )
+    end
+
+    def include_edit_marker_support
+    end
+
+    def render_marker_code
+    end
+
+  private
+
+  end
+
+end

data/lib/infopark_cloud_connector.rb

@@ -15,3 +15,5 @@ module RailsConnector
 
   autoload_all_sources
 end
+
+require "rails_connector/cloud_engine" if defined?(Rails)

data/lib/rails_connector/cloud_engine.rb

@@ -0,0 +1,5 @@
+module ::RailsConnector
+  class CloudEngine < Rails::Engine #:nodoc:
+  end
+end
+

data/lib/rails_connector/cms_api_search_request.rb

@@ -1,5 +1,3 @@
-require 'restclient'
-
 module RailsConnector
 
   # This class provides a basic implementation for accessing the search using the cms api.
@@ -13,9 +11,6 @@ module RailsConnector
     #
     # <tt>:limit</tt>:: The maximum number of hits
     # <tt>:offset</tt>:: The search offset
-    # <tt>:url</tt>:: The URL to the CMS API search
-    # <tt>:login</tt>:: The login for the CMS API search
-    # <tt>:api_key</tt>:: The api_key for the CMS API search
     def initialize(query_string, options = {})
       @query_string = query_string
       @options = Configuration.cms_api_options.merge(options)
@@ -23,25 +18,11 @@ module RailsConnector
 
     # Accesses Cms Api Search using #query and fetches search hits.
     def fetch_hits
-      headers = {
-        :content_type => :json,
-        :accept => :json,
-      }
-      headers[:host] = @options[:http_host] if @options[:http_host].present?
-      hits = MultiJson.decode(
-        RestClient::Request.execute({
-          :method => :get,
-          :url => url,
-          :user => @options[:login],
-          :password => @options[:api_key],
-          :headers => headers,
-          :payload => MultiJson.encode({
-            :query => query,
-            :offset => @options[:offset],
-            :size => @options[:limit],
-          }),
-        })
-      )
+      hits = CmsRestApi.get(resource_path, {
+        :query => query,
+        :offset => @options[:offset],
+        :size => @options[:limit],
+      })
 
       result = SES::SearchResult.new(hits['total'])
       hits['results'].each do |hit|
@@ -53,8 +34,8 @@ module RailsConnector
 
     private
 
-    def url
-      "#{@options[:url]}/revisions/#{Workspace.current.revision_id}/objs/search"
+    def resource_path
+      "revisions/#{Workspace.current.revision_id}/objs/search"
     end
 
     def query

data/lib/rails_connector/cms_backend.rb

@@ -3,9 +3,9 @@ module RailsConnector
   class CmsBackend
 
     def self.current
-      @current ||=
-        DynamoCmsBackend.new
-        # ServiceCmsBackend.new
+      @current ||= begin
+        RailsConnector::Configuration.content_service ? ServiceCmsBackend.new : DynamoCmsBackend.new
+      end
     end
 
     def self.begin_caching
@@ -16,14 +16,22 @@ module RailsConnector
       current.end_caching
     end
 
-    def self.find_obj_data_by(workspace, index, keys)
-      current.find_obj_data_by(workspace, index, keys)
+    def self.find_obj_data_by(workspace_data, index, keys)
+      current.find_obj_data_by(workspace_data, index, keys)
+    end
+
+    def self.find_workspace_data_by_id(id)
+      current.find_workspace_data_by_id(id)
     end
 
     def self.caching?
       current.caching?
     end
 
+    def self.query_counter
+      current.query_counter
+    end
+
   end
 
 end

data/lib/rails_connector/cms_rest_api.rb

@@ -0,0 +1,75 @@
+require 'restclient'
+
+module RailsConnector
+
+  # Provides a simple wrapper for the CMS Rest API
+  # using the credentials from {RailsConnector::Configuration.cms_api_options}.
+  #
+  # @example Request the published workspace:
+  #   RailsConnector::CmsRestApi.get('workspaces/published')
+  #
+  # @example Create a new Obj:
+  #   RailsConnector::CmsRestApi.post('revisions/001384beff9e5845/objs',
+  #       {'obj' => {'_path' => '/new_obj', '_obj_class' => 'Publication'}})
+  #
+  # @example Update an Obj:
+  #   RailsConnector::CmsRestApi.put('revisions/001384beff9e5845/objs/9e432077f0412a63',
+  #       {'obj' => {'title' => 'new title'}})
+  #
+  # @example Delete an Obj:
+  #   RailsConnector::CmsRestApi.delete('revisions/001384beff9e5845/objs/f4123622ff07b70b')
+  #
+  # @api private
+  class CmsRestApi
+
+    def self.get(resource_path, payload = nil)
+      request_cms_api(:get, resource_path, payload)
+    end
+
+    def self.put(resource_path, payload)
+      request_cms_api(:put, resource_path, payload)
+    end
+
+    def self.post(resource_path, payload)
+      request_cms_api(:post, resource_path, payload)
+    end
+
+    def self.delete(resource_path)
+      request_cms_api(:delete, resource_path, nil)
+    end
+
+    private
+
+    def self.request_cms_api(action, resource_path, payload)
+      request_params = basic_request_params
+      request_params[:method] = action
+      request_params[:url] = url(resource_path)
+      request_params[:payload] = MultiJson.encode(payload) if payload.present?
+
+      MultiJson.decode(RestClient::Request.execute(request_params))
+    end
+
+    def self.credentials
+      RailsConnector::Configuration.cms_api_options
+    end
+
+    def self.basic_request_params
+      headers = {
+        :content_type => :json,
+        :accept => :json,
+      }
+      headers[:host] = credentials[:http_host] if credentials[:http_host].present?
+
+      {
+        :user => credentials[:login],
+        :password => credentials[:api_key],
+        :headers => headers,
+      }
+    end
+
+    def self.url(resource_path)
+      "#{credentials[:url]}/#{resource_path}"
+    end
+  end
+
+end

data/lib/rails_connector/{connector_service.rb → content_service.rb}

@@ -1,10 +1,8 @@
-class ConnectorService
-
+class ContentService
   def self.query(path, payload)
     MultiJson.load(RestClient::Request.execute(
       :method => :post,
-      # FIXME
-      :url => "localhost:3001/#{path}",
+      :url => "#{url}/#{path}",
       :headers => {
         :content_type => :json,
         :accept => :json,
@@ -13,4 +11,12 @@ class ConnectorService
     ))
   end
 
+  private
+
+  def self.url
+    @url ||= begin
+      config = RailsConnector::Configuration.content_service
+      "#{config['login']}:#{config['api_key']}@#{config['url']}"
+    end
+  end
 end

data/lib/rails_connector/dynamo_cms_backend.rb

@@ -3,6 +3,10 @@ module RailsConnector
   class DynamoCmsBackend
     CACHE_PREFIX = 'revision'
 
+    def initialize
+      @query_counter = 0
+    end
+
     def begin_caching
       @editable_cache = Configuration.cache_editable_workspaces ? persistent_cache : Cache.new
       @read_only_cache = persistent_cache
@@ -12,8 +16,12 @@ module RailsConnector
       @editable_cache = @read_only_cache = nil
     end
 
-    def find_obj_data_by(workspace, index, keys)
-      revision = workspace.revision
+    def find_workspace_data_by_id(id)
+      WorkspaceDataFromDatabase.find(id)
+    end
+
+    def find_obj_data_by(workspace_data, index, keys)
+      revision = workspace_data.revision
       raw_data =
         if caching?
           find_obj_data_from_cache_or_database_by(revision, index, keys)
@@ -32,6 +40,10 @@ module RailsConnector
       @read_only_cache && @editable_cache
     end
 
+    def query_counter
+      @query_counter
+    end
+
     private
 
     def persistent_cache
@@ -40,6 +52,7 @@ module RailsConnector
 
     def find_obj_data_from_database_by(revision, index, keys)
       return [] if keys.blank?
+      @query_counter += 1
       instrumenter = ActiveSupport::Notifications.instrumenter
       instrumenter.instrument(
         "cms_load.rails_connector", :name => "Obj Load", :index => index, :keys => keys

data/lib/rails_connector/obj.rb

@@ -99,7 +99,7 @@ module RailsConnector
     # accepts the name of an "obj_by" - view and a list of keys.
     # returns a list of lists of Objs: a list of Objs for each given keys.
     def self.find_objs_by(view, keys) # :nodoc:
-      CmsBackend.find_obj_data_by(Workspace.current, view, keys).map do |list|
+      CmsBackend.find_obj_data_by(Workspace.current.data, view, keys).map do |list|
         list.map { |obj_data| Obj.instantiate(obj_data) }
       end
     end
@@ -434,7 +434,7 @@ module RailsConnector
     # Notice that the ruby class of this Obj instance will NOT change,
     # even if the obj_class in the database has changed.
     def reload
-      obj_data = CmsBackend.find_obj_data_by(Workspace.current, :id, [id.to_s]).first.first
+      obj_data = CmsBackend.find_obj_data_by(Workspace.current.data, :id, [id.to_s]).first.first
       update_data(obj_data)
     end
 

data/lib/rails_connector/service_cms_backend.rb

@@ -4,27 +4,91 @@ module RailsConnector
 
   # connects the cloud connector to the connector service
   class ServiceCmsBackend < CmsBackend
+    CACHE_PREFIX = 'v1'
+
+    def initialize
+      @query_counter = 0
+    end
 
     def begin_caching
-      # TODO
+      @editable_cache = Configuration.cache_editable_workspaces ? persistent_cache : Cache.new
+      @read_only_cache = persistent_cache
     end
 
     def end_caching
-      # TODO
+      @editable_cache = @read_only_cache = nil
     end
 
     def caching?
-      # TODO
+      @read_only_cache && @editable_cache
+    end
+
+    def query_counter
+      @query_counter
+    end
+
+    def find_workspace_data_by_id(id)
+      raw_data = ContentService.query(
+        "workspaces/query",
+        :workspace_id => id
+      )
+      raw_workspace_data = raw_data["workspace"] or raise "Workspace Data missing"
+      WorkspaceDataFromService.new(raw_workspace_data)
+    end
+
+    def find_obj_data_by(workspace_data, index, keys)
+      raw_data =
+        if caching?
+          find_raw_data_from_cache_or_database_by(workspace_data, index, keys)
+        else
+          find_raw_data_from_database_by(workspace_data, index, keys)
+        end
+
+      raw_data.map do |raw_list|
+        raw_list.map do |raw_obj_data|
+          ObjDataFromService.new(raw_obj_data)
+        end
+      end
+    end
+
+    private
+
+    def persistent_cache
+      Cache.new(:fallback_backend => Rails.cache, :cache_prefix => CACHE_PREFIX)
+    end
+
+    def find_raw_data_from_cache_or_database_by(workspace_data, index, keys)
+      keys_from_database = []
+      # load results from cache
+      results_from_cache = keys.map do |key|
+        cache_for(workspace_data).read(cache_key_for(workspace_data, index, key)).tap do |objs|
+          keys_from_database << key unless objs
+        end
+      end
+
+      # load cache misses from database and store them in cache
+      results_from_database =
+          find_raw_data_from_database_by(workspace_data, index, keys_from_database)
+      keys_from_database.each_with_index do |key, key_number|
+        store_raw_data_list_in_cache(workspace_data, index, key, results_from_database[key_number])
+      end
+
+      # combine the results
+      results_from_cache.map do |objs_from_cache|
+        objs_from_cache || results_from_database.shift
+      end
     end
 
-    def find_obj_data_by(workspace, index, keys)
-      raw_data = ConnectorService.query(
+    def find_raw_data_from_database_by(workspace_data, index, keys)
+      return [] if keys.blank?
+      @query_counter += 1
+      raw_data = ContentService.query(
         "objs/query",
         :queries => keys.map do |key|
           { :type => index, :param => key }
         end,
-        :workspace => workspace.id,
-        :revision => workspace.revision.id
+        :workspace_id => workspace_data.id,
+        :revision_id => workspace_data.revision_id
       )
 
       objs = {}
@@ -37,12 +101,36 @@ module RailsConnector
           id = obj_ref["id"]
 
           # TODO fetch missing ObjData from Service
-          raw_obj_data = objs[id] or raise "Data for Obj with id #{id} missing!"
-          ObjDataFromService.new(raw_obj_data)
+          objs[id] or raise "Data for Obj with id #{id} missing!"
         end
       end
     end
 
+    UNIQUE_INDICES = [:id, :path, :permalink].freeze
+
+    def store_raw_data_list_in_cache(workspace_data, index, key, raw_data_list)
+      raw_data_list.each do |values|
+        UNIQUE_INDICES.each do |unique_index|
+          store_item_in_cache(workspace_data, unique_index, values["_#{unique_index}"], [values])
+        end
+      end
+      unless UNIQUE_INDICES.include?(index)
+        store_item_in_cache(workspace_data, index, key, raw_data_list)
+      end
+    end
+
+    def store_item_in_cache(workspace_data, index, key, item)
+      cache_for(workspace_data).write(cache_key_for(workspace_data, index, key), item) if caching?
+    end
+
+    def cache_key_for(workspace_data, index, key)
+      "rev/#{workspace_data.revision_id}/obj/#{index}/#{key}"
+    end
+
+    def cache_for(workspace_data)
+      workspace_data.cachable? ? @read_only_cache : @editable_cache
+    end
+
   end
 
 end

data/lib/rails_connector/workspace.rb

@@ -1,10 +1,9 @@
 #:enddoc:
 module RailsConnector
 
-class Workspace < CmsBaseModel
-  self.key_prefix = "ws"
-
-  property :revision_id
+class Workspace
+  extend ActiveModel::Naming
+  include Kvom::ModelIdentity
 
   def self.current=(workspace_or_proc)
     @current = workspace_or_proc
@@ -22,12 +21,34 @@ class Workspace < CmsBaseModel
     find("published")
   end
 
+  def self.find(id)
+    Workspace.new(CmsBackend.find_workspace_data_by_id(id))
+  end
+
+  def initialize(workspace_data)
+    @workspace_data = workspace_data
+  end
+
+  def id
+    @workspace_data.id
+  end
+
+  def revision_id
+    @workspace_data.revision_id
+  end
+
+  def data
+    @workspace_data
+  end
+
+  # only available with direct access to dynamo
   def revision
-    @revision ||= Revision.find(revision_id)
+    @workspace_data.revision
   end
 
-  def content_cache_id=(cc)
-    revision.content_cache_id = cc
+  # only available with direct access to dynamo
+  def content_cache_id=(id)
+    @workspace_data.content_cache_id = id
   end
 
 end

data/lib/rails_connector/workspace_data_from_database.rb

@@ -0,0 +1,20 @@
+#:enddoc:
+module RailsConnector
+
+class WorkspaceDataFromDatabase < CmsBaseModel
+
+  self.key_prefix = "ws"
+
+  property :revision_id
+
+  def revision
+    @revision ||= Revision.find(revision_id)
+  end
+
+  def content_cache_id=(id)
+    revision.content_cache_id = id
+  end
+
+end
+
+end # module RailsConnector

data/lib/rails_connector/workspace_data_from_service.rb

@@ -0,0 +1,27 @@
+#:enddoc:
+module RailsConnector
+
+class WorkspaceDataFromService
+  def initialize(data)
+    @data = data
+  end
+
+  def revision_id
+    @data["revision_id"]
+  end
+
+  def id
+    @data["id"]
+  end
+
+  def cachable?
+    @data["is_cachable"]
+  end
+
+  # remove this method after DynamoCmsBackend has been removed from the Cloud Connector
+  def content_cache_id=(id)
+    # ignore, since not using content caches
+  end
+end
+
+end # module RailsConnector

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: infopark_cloud_connector
 version: !ruby/object:Gem::Version 
-  hash: 910834687
-  prerelease: 14
+  hash: -847135200
+  prerelease: 10
   segments: 
   - 6
   - 8
   - 0
-  - 110
-  - 6570
+  - 210
+  - ed
+  - 204
   - b
-  - 45
-  version: 6.8.0.110.6570b45
+  - 0
+  version: 6.8.0.210.ed204b0
 platform: ruby
 authors: 
 - Infopark AG
@@ -19,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-26 00:00:00 +02:00
+date: 2012-11-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,16 +60,17 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 910834687
+        hash: -847135200
         segments: 
         - 6
         - 8
         - 0
-        - 110
-        - 6570
+        - 210
+        - ed
+        - 204
         - b
-        - 45
-        version: 6.8.0.110.6570b45
+        - 0
+        version: 6.8.0.210.ed204b0
   version_requirements: *id003
   name: kvom
   prerelease: false
@@ -79,19 +81,22 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- app/helpers/rails_connector/marker_helper.rb
 files: 
+- app/helpers/rails_connector/marker_helper.rb
 - lib/infopark_cloud_connector.rb
 - lib/rails_connector/blob.rb
 - lib/rails_connector/cache.rb
 - lib/rails_connector/cache_middleware.rb
 - lib/rails_connector/chain.rb
+- lib/rails_connector/cloud_engine.rb
 - lib/rails_connector/cms_api_search_request.rb
 - lib/rails_connector/cms_backend.rb
 - lib/rails_connector/cms_base_model.rb
-- lib/rails_connector/connector_service.rb
+- lib/rails_connector/cms_rest_api.rb
 - lib/rails_connector/content_cache.rb
+- lib/rails_connector/content_service.rb
 - lib/rails_connector/controller_runtime.rb
 - lib/rails_connector/date_attribute.rb
 - lib/rails_connector/default_search_request.rb
@@ -116,6 +121,8 @@ files:
 - lib/rails_connector/service_cms_backend.rb
 - lib/rails_connector/version.rb
 - lib/rails_connector/workspace.rb
+- lib/rails_connector/workspace_data_from_database.rb
+- lib/rails_connector/workspace_data_from_service.rb
 - lib/rails_connector/workspace_selection_middleware.rb
 has_rdoc: true
 homepage: http://www.infopark.de