infopark_cloud_connector 6.9.5 → 7.0.0

data/lib/rails_connector/basic_obj.rb

@@ -20,7 +20,7 @@ module RailsConnector
       @_type_computer = nil
     end
 
-    # Create a new Obj instance with the given values and attributes.
+    # Create a new {BasicObj Obj} instance with the given values and attributes.
     # Normally this method should not be used.
     # Instead Objs should be loaded from the cms database.
     def initialize(obj_data = {})
@@ -38,7 +38,7 @@ module RailsConnector
 
     ### FINDERS ####################
 
-    # Find an Obj by it's id.
+    # Find an {BasicObj Obj} by its id.
     # If the paremeter is an Array containing ids, return a list of corresponding Objs.
     # @param [String, Integer, Array<String, Integer>]id_or_list
     # @return [Obj, Array<Obj>]
@@ -71,15 +71,15 @@ module RailsConnector
       ObjSearchEnumerator.new(nil).and(field, operator, value, boost)
     end
 
-    # Returns a {ObjSearchEnumerator} of all Objs.
-    # If invoked on a subclass of Obj, the result will be restricted to Obj of that subclass.
+    # Returns a {ObjSearchEnumerator} of all {BasicObj Obj}s.
+    # If invoked on a subclass of Obj, the result will be restricted to instances of that subclass.
     # @return [ObjSearchEnumerator]
     # @api public
     def self.all
       if superclass == RailsConnector::BasicObj
-        ObjSearchEnumerator.new(nil)
+        search_for_all
       else
-        find_all_by_obj_class(self.name)
+        find_all_by_obj_class(name)
       end
     end
 
@@ -88,12 +88,12 @@ module RailsConnector
     # @return [ObjSearchEnumerator]
     # @api public
     def self.find_all_by_obj_class(obj_class)
-      where(:_obj_class, :equals, obj_class)
+      search_for_all.and(:_obj_class, :equals, obj_class)
     end
 
-    # Find the Obj with the given path.
+    # Find the {BasicObj Obj} with the given path.
     # Returns +nil+ if no matching Obj exists.
-    # @param [String] path Path of the {Obj}.
+    # @param [String] path Path of the {BasicObj Obj}.
     # @return [Obj]
     # @api public
     def self.find_by_path(path)
@@ -104,10 +104,10 @@ module RailsConnector
       find_objs_by(:path, pathes).map(&:first)
     end
 
-    # Find an Obj with the given name.
+    # Find an {BasicObj Obj} with the given name.
     # If several Objs with the given name exist, an arbitrary one of these Objs is chosen and returned.
     # If no Obj with the name exits, +nil+ is returned.
-    # @param [String] name Name of the {Obj}.
+    # @param [String] name Name of the {BasicObj Obj}.
     # @return [Obj]
     # @api public
     def self.find_by_name(name)
@@ -115,23 +115,23 @@ module RailsConnector
     end
 
     # Returns a {ObjSearchEnumerator} of all Objs with the given name.
-    # @param [String] name Name of the {Obj}.
+    # @param [String] name Name of the {BasicObj Obj}.
     # @return [ObjSearchEnumerator]
     # @api public
     def self.find_all_by_name(name)
       where(:_name, :equals, name)
     end
 
-    # Returns the Obj with the given permalink, or +nil+ if no matching Obj exists.
-    # @param [String] permalink The permalink of the {Obj}.
+    # Returns the {BasicObj Obj} with the given permalink, or +nil+ if no matching Obj exists.
+    # @param [String] permalink The permalink of the {BasicObj Obj}.
     # @return [Obj]
     # @api public
     def self.find_by_permalink(permalink)
       find_objs_by(:permalink, [permalink]).first.first
     end
 
-    # Returns the Obj with the given permalink, or raise ResourceNotFound if no matching Obj exists.
-    # @param [String] permalink The permalink of the {Obj}.
+    # Returns the {BasicObj Obj} with the given permalink, or raise ResourceNotFound if no matching Obj exists.
+    # @param [String] permalink The permalink of the {BasicObj Obj}.
     # @return [Obj]
     # @api public
     def self.find_by_permalink!(permalink)
@@ -147,18 +147,18 @@ module RailsConnector
       end
     end
 
-    # Hook method to control which page classes should be avaiable for a page with given path.
+    # Hook method to control which page classes should be available for a page with given path.
     # Override it to allow only certain classes or none.
-    # Must return either {NilClass}, or {Array}.
+    # Must return either +NilClass+, or +Array+.
     #
     # Be aware that the given argument is a parent path.
     # E.g. when creating a page with path +/products/shoes+ then the argument will be +/products+.
     #
-    # If {NilClass} is returned, then all possible classes will be available.
-    # By default {NilClass} is returned.
+    # If +NilClass+ is returned, then all possible classes will be available.
+    # By default +NilClass+ is returned.
     #
-    # If {Array} is returned, then it should include desired class names.
-    # Each class name must be either a {String} or a {Symbol}.
+    # If +Array+ is returned, then it should include desired class names.
+    # Each class name must be either a +String+ or a +Symbol+.
     # Only this class names will be available. Order of the class names will be preserved.
     #
     # @param [String] parent_path Path of the parent obj
@@ -171,7 +171,7 @@ module RailsConnector
       id
     end
 
-    # return the Obj that is the parent of this Obj.
+    # return the {BasicObj Obj} that is the parent of this Obj.
     # returns +nil+ for the root Obj.
     # @api public
     def parent
@@ -190,7 +190,7 @@ module RailsConnector
       BasicObj.find_many_by_paths(ancestor_paths)
     end
 
-    # return a list of all child Objs.
+    # return a list of all child {BasicObj Obj}s.
     # @return [Array<Obj>]
     # @api public
     def children
@@ -199,13 +199,13 @@ module RailsConnector
 
     ### ATTRIBUTES #################
 
-    # returns the Obj's path as a String.
+    # returns the {BasicObj Obj}'s path as a String.
     # @api public
     def path
       read_attribute('_path') or raise 'Obj without path'
     end
 
-    # returns the Obj's name, i.e. the last component of the path.
+    # returns the {BasicObj Obj}'s name, i.e. the last component of the path.
     # @api public
     def name
       if root?
@@ -238,7 +238,7 @@ module RailsConnector
       end
     end
 
-    # Returns the root Obj, i.e. the Obj with the path "/"
+    # Returns the root {BasicObj Obj}, i.e. the Obj with the path "/"
     # @return [Obj]
     # @api public
     def self.root
@@ -246,21 +246,26 @@ module RailsConnector
           "Obj.root not found: There is no Obj with path '/'."
     end
 
-    # Returns the homepage object. This can be overwritten in your application's +Obj+.
-    # Use <tt>Obj#homepage?</tt> to check if an object is the homepage.
+    # Returns the homepage obj. This can be overwritten in your application's +Obj+.
+    # Use {#homepage?} to check if an obj is the homepage.
     # @return [Obj]
     # @api public
     def self.homepage
       root
     end
 
+    # @api private
+    def self.generate_widget_pool_id
+      SecureRandom.hex(4)
+    end
+
     # returns the obj's permalink.
     # @api public
     def permalink
       read_attribute('_permalink')
     end
 
-    # This method determines the controller that should be invoked when the Obj is requested.
+    # This method determines the controller that should be invoked when the +Obj+ is requested.
     # By default a controller matching the Obj's obj_class will be used.
     # If the controller does not exist, the CmsController will be used as a fallback.
     # Overwrite this method to force a different controller to be used.
@@ -270,7 +275,7 @@ module RailsConnector
       obj_class
     end
 
-    # This method determines the action that should be invoked when the Obj is requested.
+    # This method determines the action that should be invoked when the +Obj+ is requested.
     # The default action is 'index'.
     # Overwrite this method to force a different action to be used.
     # @return [String]
@@ -279,20 +284,20 @@ module RailsConnector
       "index"
     end
 
-    # Returns true if the current object is the homepage object.
+    # Returns true if the current obj is the {.homepage} obj.
     # @api public
     def homepage?
       self == self.class.homepage
     end
 
-    # This method is used to calculate part a part of a URL of an obj.
+    # This method is used to calculate a part of a URL of this Obj.
     #
     # The routing schema: <code><em><obj.id></em>/<em><obj.slug></em></code>
     #
     # The default is {http://apidock.com/rails/ActiveSupport/Inflector/parameterize parameterize}
     # on +obj.title+.
     #
-    # You can customize this part by overwriting +obj.slug+ in {Obj}.
+    # You can customize this part by overwriting {#slug}.
     # @return [String]
     # @api public
     def slug
@@ -343,37 +348,37 @@ module RailsConnector
 
     # Returns true if this object is active.
     # @api public
+    # @deprecated Active is deprecated without substitution.
     def active?
+      Deprecation.warn_method('Obj#active?')
       return false unless valid_from
       valid_from <= Time.now && (!valid_until || Time.now <= valid_until)
     end
 
     # compatibility with legacy apps.
     def suppress_export
+      Deprecation.warn_method('Obj#suppress_export?')
       suppressed? ? 1 : 0
     end
 
-    # Returns true if the Obj is suppressed.
+    # Returns true if the {BasicObj Obj} is suppressed.
     # A suppressed Obj does not represent an entire web page, but only a part of a page
     # (for example a teaser) and will not be delivered by the rails application
     # as a standalone web page.
     def suppressed?
+      Deprecation.warn_method('Obj#suppressed?')
       read_attribute('_suppress_export') ? true : false
     end
 
     # Returns true if the export of the object is not suppressed and the content is active?
     def exportable?
+      Deprecation.warn_method('Obj#exportable?')
       !suppressed? && active?
     end
 
     # Returns the file name to which the Content.file_extension has been appended.
     def filename
-      Rails.logger.warn(
-        "DEPRECATION WARNING: "\
-        "The Method Obj#filename is no longer supported. Please use Obj#name instead. "\
-        "From: #{caller[0]}"
-      )
-
+      Deprecation.warn_method('Obj#filename', 'Obj#name')
       name
     end
 
@@ -390,13 +395,13 @@ module RailsConnector
       path == "/"
     end
 
-    # Returns a list of exportable? children excluding the binary? ones unless :all is specfied.
+    # Returns a list of children excluding the binary? ones unless :all is specfied.
     # This is mainly used for navigations.
     # @return [Array<Obj>]
     # @api public
     def toclist(*args)
       return [] unless publication?
-      toclist = children.select{ |toc| toc.exportable? }
+      toclist = children
       toclist = toclist.reject { |toc| toc.binary? } unless args.include?(:all)
       toclist
     end
@@ -470,8 +475,12 @@ module RailsConnector
     # @api public
     def find_nearest(name)
       obj = self.class.find_by_path(root? ? "/#{name}" : "#{path}/#{name}")
-      return obj if obj and obj.active?
-      parent.find_nearest(name) unless self.root?
+
+      if obj
+        obj
+      elsif !self.root?
+        parent.find_nearest(name)
+      end
     end
 
     # This should be a SET, because it's faster in this particular case.
@@ -523,10 +532,6 @@ module RailsConnector
       update_data(obj_data)
     end
 
-    def text_links
-      read_attribute('_text_links')
-    end
-
     # @return [String]
     # @api public
     def obj_class
@@ -548,7 +553,7 @@ module RailsConnector
       read_attribute('_valid_until')
     end
 
-    # For a binary Obj, the content_type is equal to the content_type of it's body (i.e. it's data).
+    # For a binary Obj, the content_type is equal to the content_type of its body (i.e. its data).
     # For non-binary Objs, a the default content_type is "text/html".
     # Override this method in subclasses to define a different content_type.
     # Note that only Objs with content_type "text/html"
@@ -635,12 +640,7 @@ module RailsConnector
       if children.any?
         raise ClientError.new(I18n.t('rails_connector.errors.models.basic_obj.has_children'), 412)
       end
-      self.class.find_objs_by(:ppath, ["/_widgets/#{id}"]).first.map(&:destroy)
-      CmsRestApi.delete("revisions/#{Workspace.current.revision_id}/objs/#{id}")
-    end
-
-    def widget_container
-      @widget_container ||= self.class.find(parent_path.split('/').last)
+      CmsRestApi.delete("workspaces/#{Workspace.current.id}/objs/#{id}")
     end
 
     def edit_view_path
@@ -706,6 +706,14 @@ module RailsConnector
     def converted_sort_type(attribute)
       read_attribute(attribute) == 1 ? "numeric" : "alphaNumeric"
     end
+
+    class << self
+      private
+
+      def search_for_all
+        ObjSearchEnumerator.new(nil).batch_size(1000)
+      end
+    end
   end
 
 end

data/lib/rails_connector/basic_widget.rb

@@ -15,6 +15,8 @@ class BasicWidget
 
   alias_method :initialize, :update_data
 
+  delegate :widget_from_pool, to: :obj
+
   def obj_class
     data_from_cms.value_of('_obj_class')
   end

data/lib/rails_connector/cms_accessible.rb

@@ -16,23 +16,6 @@ module RailsConnector
       @obj = loaded_obj
     end
 
-    # Filter method to check if the already loaded object is active. If it is
-    # not, a 410 Gone error message will be generate (by calling render_obj_error).
-    #
-    # To require the check for all actions, use this in your controllers:
-    #   before_filter :load_object
-    #   before_filter :ensure_object_is_active
-    def ensure_object_is_active
-      unless @obj.active?
-        @valid_from = @obj.valid_from
-        @valid_until = @obj.valid_until
-        @obj = nil
-        render_obj_error(410, "gone")
-        return false
-      end
-      return true
-    end
-
     # Filter method to check if access to the loaded object is permitted. If it is
     # not, a 403 Forbidden error message will be generated (by calling render_obj_error)
     #

data/lib/rails_connector/cms_backend.rb

@@ -155,7 +155,7 @@ module RailsConnector
     end
 
     def find_raw_data_from_cache_by(workspace_data, index, key)
-      ContentStateCaching.find_obj_data(workspace_data, index, key) if caching?
+      ContentStateCaching.find_obj_data(workspace_data.content_state, index, key) if caching?
     end
 
     def find_raw_data_from_database_by(workspace_data, index, keys)
@@ -195,7 +195,7 @@ module RailsConnector
     end
 
     def store_item_in_cache(workspace_data, index, key, item)
-      ContentStateCaching.store_obj_data(workspace_data, index, key, item)
+      ContentStateCaching.store_obj_data(workspace_data.content_state, index, key, item)
     end
 
     def find_blob_data_from_database_by(id)

data/lib/rails_connector/cms_env.rb

@@ -46,11 +46,6 @@ module RailsConnector
           end
         end
 
-      if found_obj.suppressed?
-        raise RailsConnector::ResourceNotFound,
-          "Tried to access Obj #{found_obj.inspect}, but it is suppressed (suppress_export is set)!"
-      end
-
       found_obj
     end
 

data/lib/rails_connector/cms_rest_api.rb

@@ -28,6 +28,15 @@ module RailsConnector
   #   RailsConnector::CmsRestApi.task_unaware_request(:put, 'workspace/rtc/publish', nil)
   #
   class CmsRestApi
+    DEFAULT_PROTOCOL = 'https'.freeze
+
+    METHOD_TO_NET_HTTP_CLASS = {
+      :get => Net::HTTP::Get,
+      :put => Net::HTTP::Put,
+      :post => Net::HTTP::Post,
+      :delete => Net::HTTP::Delete,
+    }.freeze
+
     class Configuration
       attr_accessor :url
       attr_accessor :login
@@ -71,11 +80,18 @@ module RailsConnector
       response_for_request_cms_api(method, resource_path, payload)
     end
 
+    # This method is mainly for tests
+    def self.reset!
+      @connection_manager = nil
+    end
+
     class << self
 
       private
 
       def request_cms_api(action, resource_path, payload, options)
+        reset_connection_manager if connection_manager.uri != uri
+
         decoded = response_for_request_cms_api(action, resource_path, payload)
         return decoded unless Hash === decoded
         return decoded unless decoded.keys == ["task"]
@@ -85,26 +101,30 @@ module RailsConnector
         final_response(task_path, options)
       end
 
-      def response_for_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))
-      rescue RestClient::ExceptionWithResponse => e
-        http_code = e.http_code
-        if http_code == 403
-          raise AccessDenied.new(e.http_body)
-        elsif 400 <= http_code && http_code < 500
+      def response_for_request_cms_api(method, resource_path, payload = nil)
+        request = method_to_net_http_class(method).new(path(resource_path))
+        set_headers(request)
+        request.body = MultiJson.encode(payload) if payload.present?
+
+        handle_response(connection_manager.request(request))
+      end
+
+      def handle_response(response)
+        code = response.code.to_i
+        if code.to_s.start_with?('2')
+          MultiJson.load(response.body)
+        elsif response.code == '403'
+          raise AccessDenied.new(response.body)
+        elsif (400...500).include?(code)
           begin
-            specific_output = MultiJson.decode(e.http_body)['error']
+            specific_output = MultiJson.decode(response.body)['error']
+            raise ClientError.new(specific_output, code)
           rescue MultiJson::DecodeError
-            # fall through
-          else
-            raise ClientError.new(specific_output, http_code)
+            raise BackendNotAvailable.new(response.body, code)
           end
+        else
+          raise BackendNotAvailable.new(response.body, code)
         end
-        raise BackendNotAvailable.new(e.http_body, http_code)
       end
 
       def final_response(task_path, options)
@@ -121,22 +141,34 @@ module RailsConnector
         raise ClientError.new(message, 400)
       end
 
-      def basic_request_params
-        headers = {
-          :content_type => :json,
-          :accept => :json,
-        }
-        headers[:host] = configuration.http_host if configuration.http_host.present?
-
-        {
-          :user => configuration.login,
-          :password => configuration.api_key,
-          :headers => headers,
-        }
+      def set_headers(request)
+        request.basic_auth(configuration.login, configuration.api_key)
+        request['Content-type'] = 'application/json'
+        request['Accept'] = 'application/json'
+
+        request['Host'] = configuration.http_host if configuration.http_host.present?
+      end
+
+      def path(path)
+        "/#{path}".squeeze('/')
+      end
+
+      def connection_manager
+        @connection_manager ||= ConnectionManager.new(uri)
+      end
+
+      def uri
+        url = configuration.url
+        url = "#{DEFAULT_PROTOCOL}://#{url}" unless url.match /^http/
+        URI.parse(url)
+      end
+
+      def method_to_net_http_class(method)
+        METHOD_TO_NET_HTTP_CLASS.fetch(method)
       end
 
-      def url(resource_path)
-        "#{configuration.url}/#{resource_path}"
+      def reset_connection_manager
+        @connection_manager = ConnectionManager.new(uri)
       end
     end
   end