infopark_cloud_connector 6.9.1.3.22208381 → 6.9.2.1.125136549

data/lib/generators/cms/migration/templates/migration.rb

@@ -1,17 +1,15 @@
 class <%= class_name %> < ::RailsConnector::Migration
   def up
-    # get_attribute('test')
-    # create_attribute(:name => 'test', :type => :string)
-    # update_attribute('test', :title => 'Test Title')
-    # delete_attribute('test')
-
     # get_obj_class('Test')
-    # create_obj_class(:name => 'Test', :type => :publication)
-    # update_obj_class('Test', :title => 'Test Title')
+    # create_obj_class(name: 'Test', type: :publication, attributes: [])
+    # update_obj_class('Test', title: 'Test Title')
+    # add_attribute_to('Test', { name: 'test', type: 'string' })
+    # update_attribute_for('Test', 'test', { title: 'New Title' })
+    # delete_attribute_from('Test', 'test')
 
     # get_obj('a1b2c3')
-    # create_obj(:_path => '/test', :_obj_class => 'Test')
-    # update_obj('a1b2c3', :title => 'Test Title')
+    # create_obj(_path: '/test', _obj_class: 'Test')
+    # update_obj('a1b2c3', title: 'Test Title')
     # delete_obj('a1b2c3')
   end
 end

data/lib/rails_connector/backend_not_available.rb

@@ -8,7 +8,7 @@ module RailsConnector
     end
 
     def initialize(message, http_code)
-      @http_code = http_code
+      @http_code = http_code.to_i
       super(message)
     end
   end

data/lib/rails_connector/basic_obj.rb

@@ -8,7 +8,6 @@ module RailsConnector
     extend ActiveModel::Naming
 
     include DateAttribute
-    include SEO
     include ModelIdentity
 
     # Create a new Obj instance with the given values and attributes.
@@ -343,12 +342,11 @@ module RailsConnector
       object_type == :document
     end
 
-    # Returns true if this object is active (time_when is in object's time interval)
+    # Returns true if this object is active.
     # @api public
-    def active?(time_when = nil)
+    def active?
       return false unless valid_from
-      time_then = time_when || BasicObj.preview_time
-      valid_from <= time_then && (!valid_until || time_then <= valid_until)
+      valid_from <= Time.now && (!valid_until || Time.now <= valid_until)
     end
 
     # compatibility with legacy apps.
@@ -365,8 +363,8 @@ module RailsConnector
     end
 
     # Returns true if the export of the object is not suppressed and the content is active?
-    def exportable?(current_time = nil)
-      !suppressed? && active?(current_time)
+    def exportable?
+      !suppressed? && active?
     end
 
     # Returns the file name to which the Content.file_extension has been appended.
@@ -404,8 +402,7 @@ module RailsConnector
     # @api public
     def toclist(*args)
       return [] unless publication?
-      time = args.detect {|value| value.kind_of? Time}
-      toclist = children.select{ |toc| toc.exportable?(time) }
+      toclist = children.select{ |toc| toc.exportable? }
       toclist = toclist.reject { |toc| toc.binary? } unless args.include?(:all)
       toclist
     end
@@ -638,10 +635,6 @@ module RailsConnector
       end
     end
 
-    def to_liquid
-      LiquidSupport::ObjDrop.new(self)
-    end
-
     def respond_to?(method_id, include_private=false)
       if has_attribute?(method_id)
         true
@@ -650,14 +643,6 @@ module RailsConnector
       end
     end
 
-    def self.preview_time=(t)
-      Thread.current[:preview_time] = t
-    end
-
-    def self.preview_time
-      Thread.current[:preview_time] || Time.now
-    end
-
     def inspect
       "<#{self.class} id=\"#{id}\" path=\"#{path}\">"
     end
@@ -697,6 +682,10 @@ module RailsConnector
       CmsRestApi.delete("revisions/#{Workspace.current.revision_id}/objs/#{id}")
     end
 
+    def widget_container
+      @widget_container ||= self.class.find(parent_path.split('/').last)
+    end
+
     private
 
     attr_accessor :data_from_cms

data/lib/rails_connector/cache.rb

@@ -1,7 +1,7 @@
 module RailsConnector
 
 class Cache
-  attr_reader :cache_prefix
+  attr_reader :cache_prefix, :fallback_backend
 
   def initialize(options = {})
     @fallback_backend, @cache_prefix = options[:fallback_backend], options[:cache_prefix]

data/lib/rails_connector/cms_cache_storage.rb

@@ -11,10 +11,19 @@ module CmsCacheStorage
       @cache ||= begin
         prefix = VERSION.dup
         prefix.concat('-utf8') if String.new.encoding_aware?
-        Cache.new(fallback_backend: Rails.cache, cache_prefix: prefix)
+        Cache.new(fallback_backend: backend_cache, cache_prefix: prefix)
       end
     end
 
+    def backend_cache=(new_cache)
+      @backend_cache = new_cache
+      @cache = nil
+    end
+
+    def backend_cache
+      @backend_cache || Rails.cache
+    end
+
     def read_workspace_data(workspace_id)
       cache.read("workspace/#{workspace_id}")
     end

data/lib/rails_connector/cms_rest_api.rb

@@ -19,23 +19,38 @@ module RailsConnector
   #
   # @example Delete an Obj:
   #   RailsConnector::CmsRestApi.delete('revisions/001384beff9e5845/objs/f4123622ff07b70b')
+  #
+  # @example Specify a poll interval (in seconds; default: 2) to use in case the response
+  # is a task reference response and the final response is polled for:
+  #   RailsConnector::CmsRestApi.put('workspace/rtc/publish', nil, :interval => 10)
+  #
+  # @example Return immediately with the first response (without polling in case it is a
+  # task reference response):
+  #   RailsConnector::CmsRestApi.task_unaware_request(:put, 'workspace/rtc/publish', nil)
+  #
   class CmsRestApi
+
     cattr_accessor :credentials
 
-    def self.get(resource_path, payload = nil)
-      request_cms_api(:get, resource_path, payload)
+    def self.get(resource_path, payload = nil, options = nil)
+      request_cms_api(:get, resource_path, payload, options)
     end
 
-    def self.put(resource_path, payload)
-      request_cms_api(:put, resource_path, payload)
+    def self.put(resource_path, payload, options = nil)
+      request_cms_api(:put, resource_path, payload, options)
     end
 
-    def self.post(resource_path, payload)
-      request_cms_api(:post, resource_path, payload)
+    def self.post(resource_path, payload, options = nil)
+      request_cms_api(:post, resource_path, payload, options)
     end
 
-    def self.delete(resource_path, payload = nil)
-      request_cms_api(:delete, resource_path, payload)
+    def self.delete(resource_path, payload = nil, options = nil)
+      request_cms_api(:delete, resource_path, payload, options)
+    end
+
+    def self.task_unaware_request(method, resource_path, payload = nil)
+      raise "Unexpected method #{method}" unless [:delete, :get, :post, :put].include?(method)
+      response_for_request_cms_api(method, resource_path, payload)
     end
 
     # @param [Hash] value
@@ -44,48 +59,73 @@ module RailsConnector
       @@credentials = value.symbolize_keys
     end
 
-    private
+    class << self
 
-    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?
+      private
+
+      def request_cms_api(action, resource_path, payload, options)
+        decoded = response_for_request_cms_api(action, resource_path, payload)
+        return decoded unless Hash === decoded
+        return decoded unless decoded.keys == ["task"]
+        task_data = decoded["task"]
+        return decoded unless Hash === task_data
+        task_path = "tasks/#{task_data["id"]}"
+        final_response(task_path, options)
+      end
 
-      begin
+      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
-        begin
-          if e.http_code == 403
-            raise AccessDenied.new(e.http_body)
-          elsif e.http_code.to_s.match(/4\d{2}/) &&
-              (specific_output = MultiJson.decode(e.http_body)['error'])
-            raise ClientError.new(specific_output, e.http_code)
+        http_code = e.http_code
+        if http_code == 403
+          raise AccessDenied.new(e.http_body)
+        elsif 400 <= http_code && http_code < 500
+          begin
+            specific_output = MultiJson.decode(e.http_body)['error']
+          rescue MultiJson::DecodeError
+            # fall through
+          else
+            raise ClientError.new(specific_output, http_code)
           end
-        rescue MultiJson::DecodeError
         end
+        raise BackendNotAvailable.new(e.http_body, http_code)
+      end
 
-        raise BackendNotAvailable.new(e.http_body, e.http_code)
+      def final_response(task_path, options)
+        options ||= {}
+        wait = options[:interval].presence.try(:to_f) || 2
+        task_data = response = nil
+        loop do
+          sleep wait
+          task_data = response_for_request_cms_api(:get, task_path, nil)
+          break unless task_data["status"] == "open"
+        end
+        return task_data["result"] if task_data["status"] == "success"
+        message = task_data["message"] || "Missing error message in task response #{task_data}"
+        raise ClientError.new(message, 400)
       end
-    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 basic_request_params
+        headers = {
+          :content_type => :json,
+          :accept => :json,
+        }
+        headers[:host] = credentials[:http_host] if credentials[:http_host].present?
 
-    def self.url(resource_path)
-      "#{credentials[:url]}/#{resource_path}"
+        {
+          :user => credentials[:login],
+          :password => credentials[:api_key],
+          :headers => headers,
+        }
+      end
+
+      def url(resource_path)
+        "#{credentials[:url]}/#{resource_path}"
+      end
     end
   end
-
 end

data/lib/rails_connector/content_service.rb

@@ -107,7 +107,7 @@ class ContentService
       elsif response.code == "429"
         raise RateLimitExceeded.new(response["Retry-After"])
       else
-        raise "Server responded with status code #{response.code}"
+        raise BackendNotAvailable.new("Server responded with status code #{response.code}", response.code)
       end
     end
 

data/lib/rails_connector/date_attribute.rb

@@ -19,7 +19,7 @@ module RailsConnector
     end
 
     def self.parse(iso_date_time)
-      Time.from_iso(iso_date_time).localtime
+      Time.from_iso(iso_date_time).in_time_zone
     rescue ArgumentError
       raise "The value is not a valid ISO date time: #{iso_date_time.inspect}"
     end

data/lib/rails_connector/link.rb

@@ -135,10 +135,6 @@ module RailsConnector
       nil
     end
 
-    def to_liquid
-      LiquidSupport::LinkDrop.new(self)
-    end
-
     private
 
     def resolved_internal?

data/lib/rails_connector/migrations/migration_dsl.rb

@@ -7,7 +7,7 @@ module RailsConnector
       #
       # @example Create "test" Attribute
       #
-      #   create_attribute(:name => 'test', :type => 'string')
+      #   create_attribute(name: 'test', type: 'string')
       #
       # @param attributes [Hash] The attributes and their values of the new
       #   CMS attribute.
@@ -20,14 +20,94 @@ module RailsConnector
         warn_deprecated __callee__, 'create_obj_class', 'update_obj_class'
         endpoint = "revisions/#{Workspace.current.revision_id}/attributes"
 
-        CmsRestApi.post(endpoint, :attribute => attributes)
+        CmsRestApi.post(endpoint, attribute: attributes)
+      end
+
+      # Adds an attribute to an object class.
+      #
+      # @example Add "test" attribute to object class "Foo.
+      #
+      #   add_attribute_to('Foo', { name: 'test', type: 'string' })
+      #
+      # @param obj_class_name [String] The class name of the object class.
+      # @param params [Hash] The definition of the new attribute.
+      #
+      # @return nothing
+      def add_attribute_to(obj_class_name, params)
+        attributes = get_obj_class(obj_class_name)['attributes']
+        attributes << params
+
+        update_obj_class(obj_class_name, attributes: attributes)
+      end
+
+      # Deletes an attribute from an object class.
+      #
+      # @example Delete "test" attribute from object class "Foo.
+      #
+      #   delete_attribute_from('Foo', 'test')
+      #
+      # @param obj_class_name [String] The class name of the object class.
+      # @param attribute_name [String] The name of the attribute that should be
+      #   deleted.
+      #
+      # @return nothing
+      def delete_attribute_from(obj_class_name, attribute_name)
+        attributes = get_obj_class(obj_class_name)['attributes']
+        attributes = attributes.delete_if do |attribute|
+          # handle global and local attributes
+          name = attribute.is_a?(String) ? attribute : attribute['name']
+
+          name == attribute_name.to_s
+        end
+
+        update_obj_class(obj_class_name, attributes: attributes)
+      end
+
+      # Updates an attribute for an object class. Turns local into global
+      # attribute if found.
+      #
+      # @example Update "test" attribute for object class "Foo.
+      #
+      #   update_attribute_for('Foo', 'test', { title: 'New Title' })
+      #
+      # @param obj_class_name [String] The class name of the object class.
+      # @param attribute_name [String] The name of the attribute that should be
+      #   updated.
+      # @param params [Hash] Hash of updated attributes.
+      #
+      # @return nothing
+      def update_attribute_for(obj_class_name, attribute_name, params)
+        attribute_name = attribute_name.to_s
+        attributes = get_obj_class(obj_class_name)['attributes']
+        found = false
+
+        attributes.each_with_index do |attribute, index|
+          name = attribute.is_a?(String) ? attribute : attribute['name']
+
+          if name == attribute_name
+            if attribute.is_a?(String)
+              attribute = get_attribute(attribute)
+            end
+
+            attributes[index] = attribute.merge(params.stringify_keys)
+            update_obj_class(obj_class_name, attributes: attributes)
+
+            found = true
+
+            break
+          end
+        end
+
+        unless found
+          raise ArgumentError.new("Object class '#{obj_class_name}' does not have attribute '#{attribute_name}'.")
+        end
       end
 
       # Creates a CMS object.
       #
       # @example Create "/test" Object
       #
-      #   create_obj(:_path => '/test', :_obj_class => 'Test')
+      #   create_obj(_path: '/test', _obj_class: 'Test')
       #
       # @param attributes [Hash] The attributes and their values of the new
       #   CMS object.
@@ -37,14 +117,14 @@ module RailsConnector
       def create_obj(attributes = {})
         endpoint = "revisions/#{Workspace.current.revision_id}/objs"
 
-        CmsRestApi.post(endpoint, :obj => attributes)
+        CmsRestApi.post(endpoint, obj: attributes)
       end
 
       # Creates a CMS object class.
       #
       # @example Create "Test" Object Class
       #
-      #   create_obj_class(:name => 'Test', :type => 'publication')
+      #   create_obj_class(name: 'Test', type: 'publication')
       #
       # @param attributes [Hash] The attributes and their values of the new
       #   CMS object class.
@@ -54,7 +134,7 @@ module RailsConnector
       def create_obj_class(attributes = {})
         endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes"
 
-        CmsRestApi.post(endpoint, :obj_class => attributes)
+        CmsRestApi.post(endpoint, obj_class: attributes)
       end
 
       # Deletes a CMS attribute.
@@ -145,7 +225,7 @@ module RailsConnector
       #
       # @example Update the title of the "test" Attribute
       #
-      #   update_attribute(:title => 'Test Title')
+      #   update_attribute(title: 'Test Title')
       #
       # @param id [String] The ID of the attribute.
       # @param attributes [Hash] The updated attributes and their values.
@@ -157,14 +237,14 @@ module RailsConnector
         warn_deprecated __callee__, 'update_obj_class'
         endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
 
-        CmsRestApi.put(endpoint, :attribute => attributes)
+        CmsRestApi.put(endpoint, attribute: attributes)
       end
 
       # Updates a CMS object.
       #
       # @example Update the title of the "a1b2c3" Object
       #
-      #   update_attribute('a1b2c3', :title => 'Test Title')
+      #   update_attribute('a1b2c3', title: 'Test Title')
       #
       # @param id [String] The ID of the CMS object.
       # @param attributes [Hash] The updated attributes and their values.
@@ -174,14 +254,14 @@ module RailsConnector
       def update_obj(id, attributes = {})
         endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
 
-        CmsRestApi.put(endpoint, :obj => attributes)
+        CmsRestApi.put(endpoint, obj: attributes)
       end
 
       # Updates a CMS object class.
       #
       # @example Update the title of the "Test" Object Class
       #
-      #   update_obj_class('Test', :title => 'Test Title')
+      #   update_obj_class('Test', title: 'Test Title')
       #
       # @param id [String] The ID of the CMS object class.
       # @param attributes [Hash] The updated attributes and their values.
@@ -191,7 +271,31 @@ module RailsConnector
       def update_obj_class(id, attributes = {})
         endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes/#{id}"
 
-        CmsRestApi.put(endpoint, :obj_class => attributes)
+        CmsRestApi.put(endpoint, obj_class: attributes)
+      end
+
+      # Uploads a file to the content store.
+      #
+      # @example Upload "image.png" and store it in an "Image" CMS object.
+      #
+      #   filename = 'image.png'
+      #   file = File.new(filename)
+      #   blob = upload_file(file)
+      #   create_obj(_path: "/resources/images/#{filename}", _obj_class: 'Image', blob: blob)
+      #
+      # @param file [IO] The file IO object that gets uploaded.
+      #
+      # @return The blob of the uploaded file that can be stored on a CMS object.
+      # @api public
+      def upload_file(file)
+        upload_permission = RailsConnector::CmsRestApi.get('blobs/upload_permission')
+
+        fields = upload_permission['fields'].map { |name, value| [name, value] }
+        fields << [:file, file]
+
+        RestClient.post(upload_permission['url'], fields)
+
+        upload_permission['blob']
       end
 
       private