infopark_cloud_connector 6.9.5 → 7.0.0

data/lib/rails_connector/configuration.rb

@@ -42,7 +42,7 @@ module RailsConnector
       # Use this method to configure the directory that should be used to store cached data.
       # By default, +RAILS_ROOT/tmp/infopark_cache+ will be used.
       # @param path [String] Path to directory that should be used to store cached data.
-      # @example Configure +RailsConnector+ to store it's cache under +/tmp/my_cache+.
+      # @example Configure +RailsConnector+ to store its cache under +/tmp/my_cache+.
       #     RailsConnector::Configuration.cache_path = '/tmp/my_cache'
       # @api public
       def cache_path=(path)
@@ -156,8 +156,8 @@ module RailsConnector
 
       # Configure a callback to be invoked when the rails connector delivers the homepage.
       # The given callback will receive the rack env
-      # and must return an Obj to be used as the homepage.
-      # If no callback is configured, Obj.homepage will be used as the default.
+      # 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

data/lib/rails_connector/connection_manager.rb

@@ -0,0 +1,98 @@
+module RailsConnector
+  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
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def request(request, timeout=DEFAULT_TIMEOUT)
+      request['User-Agent'] = user_agent
+
+      retry_once_and_reset_connection do
+        ensure_started(uri, timeout)
+        connection.request(request)
+      end
+    end
+
+    private
+
+    attr_accessor :connection
+
+    def ensure_started(uri, timeout=DEFAULT_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 = RailsConnector::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_once_and_reset_connection
+      retried = false
+      begin
+        yield
+      rescue *SOCKET_ERRORS => e
+        raise BackendNotAvailable.from_socket_error(e) if retried
+        ensure_finished
+        retried = true
+        retry
+      end
+    end
+
+    def retry_twice_on_socket_error
+      attempt = 0
+      begin
+        yield
+      rescue *SOCKET_ERRORS => e
+        raise BackendNotAvailable.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["infopark_cloud_connector"]
+        if gem_info
+          "#{gem_info.name}-#{gem_info.version}"
+        end
+      )
+    end
+  end
+end

data/lib/rails_connector/content_service.rb

@@ -4,20 +4,7 @@ require 'net/http'
 module RailsConnector
 class ContentService
   DEFAULT_PROTOCOL = 'https'.freeze
-  DEFAULT_TIMEOUT = 10.freeze
-
-  SOCKET_ERRORS = [
-    EOFError,
-    Errno::ECONNABORTED,
-    Errno::ECONNREFUSED,
-    Errno::ECONNRESET,
-    Errno::EINVAL,
-    Errno::EPIPE,
-    Errno::ETIMEDOUT,
-    IOError,
-    SocketError,
-    Timeout::Error,
-  ].freeze
+
 
   class Configuration
     attr_accessor :url
@@ -70,16 +57,13 @@ class ContentService
     @next_request_not_before = nil
 
     def query(path, payload, options={})
-      timeout = options.fetch(:timeout, DEFAULT_TIMEOUT)
-      retry_once_on_socket_error do
-        retry_until_timeout_on_rate_limit_exceeded do
-          ConnectionManager.ensure_started(uri, timeout)
-          request = build_request(path, payload)
-          if @next_request_not_before && @next_request_not_before > (now = Time.now)
-            sleep @next_request_not_before - now
-          end
-          handle_response(ConnectionManager.connection(timeout).request(request))
+      timeout = options.fetch(:timeout, ConnectionManager::DEFAULT_TIMEOUT)
+      retry_until_timeout_on_rate_limit_exceeded do
+        request = build_request(path, payload)
+        if @next_request_not_before && @next_request_not_before > (now = Time.now)
+          sleep @next_request_not_before - now
         end
+        handle_response(connection_manager.request(request, timeout))
       end
     end
 
@@ -88,20 +72,14 @@ class ContentService
       @next_request_not_before = nil
     end
 
-    private
+    attr_writer :connection_manager
 
-    def retry_once_on_socket_error
-      retried = false
-      begin
-        yield
-      rescue *SOCKET_ERRORS => e
-        raise BackendNotAvailable.from_socket_error(e) if retried
-        ConnectionManager.ensure_finished
-        retried = true
-        retry
-      end
+    def connection_manager
+      @connection_manager ||= ConnectionManager.new(uri)
     end
 
+    private
+
     def retry_until_timeout_on_rate_limit_exceeded
       delay = Delay.new
       begin
@@ -145,73 +123,13 @@ class ContentService
       headers = {
         'Content-Type' => 'application/json',
         'Accept' => 'application/json',
-        'User-Agent' => user_agent,
       }
       if configuration.http_host
         headers['Host'] = configuration.http_host
       end
       headers
     end
-
-    def user_agent
-      @user_agent ||= (
-        gem_info = Gem.loaded_specs["infopark_cloud_connector"]
-        "#{gem_info.name}-#{gem_info.version}"
-      )
-    end
   end
 
-  module ConnectionManager
-    def self.connection(timeout=DEFAULT_TIMEOUT)
-      configure_timeout(@connection, timeout) if @connection
-      @connection
-    end
-
-    def self.connection=(conn)
-      @connection = conn
-    end
-
-    def self.ensure_started(uri, timeout=DEFAULT_TIMEOUT)
-      return if @connection && @connection.started?
-      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 = RailsConnector::Configuration.ca_file
-      end
-      configure_timeout(conn, timeout)
-      retry_twice_on_socket_error do
-        conn.start
-      end
-      @connection = conn
-    end
-
-    def self.ensure_finished
-      @connection.finish if @connection && @connection.started?
-      @connection = nil
-    end
-
-    class << self
-      private
-
-      def retry_twice_on_socket_error
-        attempt = 0
-        begin
-          yield
-        rescue *ContentService::SOCKET_ERRORS => e
-          raise BackendNotAvailable.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
-
-    end
-  end
 end
 end

data/lib/rails_connector/content_state_caching.rb

@@ -2,7 +2,7 @@ module RailsConnector
 
 # This module provides advances auto-invalidating caching mechanism for storing obj data.
 #
-# To keep it up-to-date it's caches and changes should be updated periodically
+# To keep it up-to-date its caches and changes should be updated periodically
 # It's changes should be updated every time a new workspace data has been fetched.
 # It's caches should be updated every time a new obj data has been fetched.
 module ContentStateCaching
@@ -16,15 +16,13 @@ module ContentStateCaching
 
     # Updates caches with data from given workspace.
     # Should be called every time a new OBJ data has been fetched.
-    def store_obj_data(workspace_data, index, key, data)
-      content_state = workspace_data.content_state
+    def store_obj_data(content_state, index, key, data)
       content_state.save_obj_data(index, key, data) if content_state
     end
 
     # Fetches up-to-date obj data for given workspace, index and key.
     # Returns nil if no up-to-date data found.
-    def find_obj_data(workspace_data, index, key)
-      return unless current_content_state = workspace_data.content_state
+    def find_obj_data(current_content_state , index, key)
       if index == 'permalink'
         current_content_state.find_obj_data(index, key)
       else

data/lib/rails_connector/deprecation.rb

@@ -0,0 +1,21 @@
+module RailsConnector
+  class Deprecation
+    class << self
+      def warn(message, source = caller(1))
+        ActiveSupport::Deprecation.warn(message, source)
+      end
+
+      def warn_method(depricated_method_name, new_method_name = nil)
+        warn(warn_method_message(depricated_method_name, new_method_name), caller(1))
+      end
+
+      private
+
+      def warn_method_message(depricated_method_name, new_method_name = nil)
+        message = "The method #{depricated_method_name} will be removed from the CloudConnector. "
+        message << "Please use #{new_method_name} instead" if new_method_name
+        message
+      end
+    end
+  end
+end

data/lib/rails_connector/link.rb

@@ -10,7 +10,7 @@ module RailsConnector
     # @api public
     # @param [Hash] link_data
     # @option link_data [String] url
-    # @option link_data [RailsConnector::BasicObj] obj
+    # @option link_data [Obj] obj
     # @option link_data [String] title
     # @option link_data [String] query
     # @option link_data [String] target
@@ -34,17 +34,17 @@ module RailsConnector
       @link_data[:url] = value
     end
 
-    # Returns the (+Obj+) this link is referencing. May be nil if the
+    # Returns the {BasicObj Obj} this link is referencing. May be nil if the
     # link is external.
     # @api public
     def obj
       @link_data[:obj]
     end
 
-    # Set the (+Obj+) this link is referencing. May be nil if the
+    # Set the {BasicObj Obj} this link is referencing. May be nil if the
     # link is external.
     # @api public
-    # @param value [RailsConnector::BasicObj] the obj this link should be referencing
+    # @param value [Obj] the obj this link should be referencing
     def obj=(value)
       @link_data[:obj] = value
     end
@@ -131,11 +131,11 @@ module RailsConnector
       end
     end
 
-    # Returns the id of the Links' destination_object.
+    # Returns the id of the Links' destination obj.
     # @api public
     # @deprecated use {#obj}.id instead
     def destination_object_id
-      deprecation_warning(:destination_object_id, 'obj.id')
+      Deprecation.warn_method('Link#destination_object_id', 'obj.id')
       obj.id
     end
 
@@ -162,10 +162,12 @@ module RailsConnector
       !internal?
     end
 
-    # An internal Link is active if it's destination object is active.
+    # An internal Link is active if its destination obj is active.
     # An external Link is always active.
     # @api public
+    # @ deprecated this method will be removed without substitution
     def active?
+      Deprecation.warn_method('Link#active?')
       external? || (obj && obj.active?)
     end
 
@@ -174,15 +176,15 @@ module RailsConnector
     end
 
     def resolved?
-      external? || resolved_internal?
+      external? || !obj.nil?
     end
 
-    # Returns the destination object (+Obj+) of this Link. May be nil if the
+    # Returns the destination obj ({BasicObj Obj}) of this Link. May be nil if the
     # link is external or internal without an existing destination object.
     # @api public
     # @deprecated use {#obj} instead
     def destination_object
-      deprecation_warning(:destination_object, :obj)
+      Deprecation.warn_method('Link#destination_object', :obj)
       obj
     end
 
@@ -209,17 +211,5 @@ module RailsConnector
       external_prefix? ? url.gsub(/external:/, '').strip : url
     end
 
-    private
-
-    def resolved_internal?
-      internal? && !obj.nil?
-    end
-
-    def deprecation_warning(method, alternative)
-      ActiveSupport::Deprecation.warn(
-        "[DEPRECATION] The medod #{method} will be removed from the RailsConnector. Please use #{alternative} instead"
-      )
-    end
-
   end
 end

data/lib/rails_connector/migrations/cms_backend.rb

@@ -87,7 +87,7 @@ module RailsConnector
       end
 
       def endpoint(path)
-        "revisions/#{Workspace.current.revision_id}/#{path}"
+        "workspaces/#{Workspace.current.id}/#{path}"
       end
     end
   end

data/lib/rails_connector/migrations/migration.rb

@@ -9,7 +9,7 @@ module RailsConnector
     #
     #   class CreateTestAttribute < RailsConnector::Migrations::Migration
     #     def up
-    #       create_attribute(:name => 'test', :type => 'string')
+    #       add_attribute_to('homepage', :name => 'test', :type => 'string')
     #     end
     #   end
     class Migration

data/lib/rails_connector/migrations/migration_dsl.rb

@@ -3,26 +3,6 @@ module RailsConnector
   module Migrations
     # @api public
     module MigrationDsl
-      # Creates a CMS attribute.
-      #
-      # @example Create "test" Attribute
-      #
-      #   create_attribute(name: 'test', type: 'string')
-      #
-      # @param attributes [Hash] The attributes and their values of the new
-      #   CMS attribute.
-      #
-      # @return nothing
-      # @deprecated Please use local attributes. Create attributes using {#create_obj_class} or
-      #   {#update_obj_class}.
-      # @api public
-      def create_attribute(attributes = {})
-        warn_deprecated __callee__, 'create_obj_class', 'update_obj_class'
-        endpoint = "revisions/#{Workspace.current.revision_id}/attributes"
-
-        CmsRestApi.post(endpoint, attribute: attributes)
-      end
-
       # Adds an attribute to an object class.
       #
       # @example Add "test" attribute to object class "Foo.
@@ -54,17 +34,13 @@ module RailsConnector
       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
+          attribute['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.
+      # Updates an attribute for an object class.
       #
       # @example Update "test" attribute for object class "Foo.
       #
@@ -82,13 +58,7 @@ module RailsConnector
         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
-
+          if attribute['name'] == attribute_name
             attributes[index] = attribute.merge(params.stringify_keys)
             update_obj_class(obj_class_name, attributes: attributes)
 
@@ -115,7 +85,7 @@ module RailsConnector
       # @return nothing
       # @api public
       def create_obj(attributes = {})
-        endpoint = "revisions/#{Workspace.current.revision_id}/objs"
+        endpoint = "workspaces/#{Workspace.current.id}/objs"
 
         CmsRestApi.post(endpoint, obj: attributes)
       end
@@ -132,29 +102,11 @@ module RailsConnector
       # @return nothing
       # @api public
       def create_obj_class(attributes = {})
-        endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes"
+        endpoint = "workspaces/#{Workspace.current.id}/obj_classes"
 
         CmsRestApi.post(endpoint, obj_class: attributes)
       end
 
-      # Deletes a CMS attribute.
-      #
-      # @example Delete "test" Attribute
-      #
-      #   delete_attribute('test')
-      #
-      # @param id [String] The ID of the CMS attribute.
-      #
-      # @return nothing
-      # @deprecated Please use local attributes. Delete attributes using {#update_obj_class}.
-      # @api public
-      def delete_attribute(id)
-        warn_deprecated __callee__, 'update_obj_class'
-        endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
-
-        CmsRestApi.delete(endpoint)
-      end
-
       # Deletes a CMS object with the given id.
       #
       # @example Deletes "a1b2c3" Object
@@ -166,29 +118,11 @@ module RailsConnector
       # @return nothing
       # @api public
       def delete_obj(id)
-        endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
+        endpoint = "workspaces/#{Workspace.current.id}/objs/#{id}"
 
         CmsRestApi.delete(endpoint)
       end
 
-      # Fetches all attribute attributes and their values.
-      #
-      # @example Get all attributes for the attribute "test"
-      #
-      #   get_attribute('test')
-      #
-      # @param id [String] The ID of the attribute.
-      #
-      # @return [Hash] a hash with attributes and their values.
-      # @deprecated Please use local attributes. Get attributes using {#get_obj_class}.
-      # @api public
-      def get_attribute(id)
-        warn_deprecated __callee__, 'get_obj_class'
-        endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
-
-        CmsRestApi.get(endpoint)
-      end
-
       # Fetches all object attributes and their values.
       #
       # @example Get all attributes for the obj with id "abc123"
@@ -200,7 +134,7 @@ module RailsConnector
       # @return [Hash] a hash with attributes and their values.
       # @api public
       def get_obj(id)
-        endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
+        endpoint = "workspaces/#{Workspace.current.id}/objs/#{id}"
 
         CmsRestApi.get(endpoint)
       end
@@ -216,30 +150,11 @@ module RailsConnector
       # @return [Hash] a hash with attributes and their values.
       # @api public
       def get_obj_class(id)
-        endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes/#{id}"
+        endpoint = "workspaces/#{Workspace.current.id}/obj_classes/#{id}"
 
         CmsRestApi.get(endpoint)
       end
 
-      # Updates a CMS attribute.
-      #
-      # @example Update the title of the "test" Attribute
-      #
-      #   update_attribute(title: 'Test Title')
-      #
-      # @param id [String] The ID of the attribute.
-      # @param attributes [Hash] The updated attributes and their values.
-      #
-      # @return nothing
-      # @deprecated Please use local attributes. Update attributes using {#update_obj_class}.
-      # @api public
-      def update_attribute(id, attributes = {})
-        warn_deprecated __callee__, 'update_obj_class'
-        endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
-
-        CmsRestApi.put(endpoint, attribute: attributes)
-      end
-
       # Updates a CMS object.
       #
       # @example Update the title of the "a1b2c3" Object
@@ -252,7 +167,7 @@ module RailsConnector
       # @return nothing
       # @api public
       def update_obj(id, attributes = {})
-        endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
+        endpoint = "workspaces/#{Workspace.current.id}/objs/#{id}"
 
         CmsRestApi.put(endpoint, obj: attributes)
       end
@@ -269,7 +184,7 @@ module RailsConnector
       # @return nothing
       # @api public
       def update_obj_class(id, attributes = {})
-        endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes/#{id}"
+        endpoint = "workspaces/#{Workspace.current.id}/obj_classes/#{id}"
 
         CmsRestApi.put(endpoint, obj_class: attributes)
       end
@@ -297,12 +212,6 @@ module RailsConnector
 
         upload_permission['blob']
       end
-
-      private
-
-      def warn_deprecated(method, *substitutes)
-        warn "[DEPRECATION] '#{method}' is deprecated. Use '#{substitutes.join("' or '")}' instead."
-      end
     end
   end
 end