infopark_rails_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/lib/rails_connector/configuration.rb

@@ -5,19 +5,23 @@ require "rails_connector/blob"
 
 module RailsConnector
 
-  # RailsConnector::Configuration is used to en/disable and initialize addons.
+  # {RailsConnector::Configuration} is used to en/disable and initialize addons.
+  # @api public
   class Configuration
+    # @api public
     DEFAULT_MODE = :live
 
     #
-    # Default fields which the +DefaultUserController+ will store in the session.
+    # Default fields which the {DefaultUserController} will store in the session.
     #
+    # @api public
     DEFAULT_STORE_USER_ATTRS_IN_SESSION = [:login, :first_name, :last_name, :email, :id]
 
     @features = {}
 
     class << self
       # Automatically generate editmarkers when rendering liquid templates in editor mode.
+      # @api public
       attr_accessor :auto_liquid_editmarkers
 
       # there are three available modes for the rails connector:
@@ -25,77 +29,98 @@ module RailsConnector
       # <tt>preview</tt> (show edited contents)
       # <tt>editor</tt> (show edited contents and editor interface (e.g. edit markers))
       # Default mode is <tt>live</tt>.
+      # @api public
       attr_accessor :mode
 
-      # default options for SearchRequest
+      # default options for {SearchRequest}
+      # @api public
       attr_writer :search_options
 
       # default options for CMS API
+      # @api public
       attr_writer :cms_api_options
 
       # Cache also editable workspaces.
       # Editable workspaces will be cached until the cache is cleared manually.
       # Should never be used in a production environment.
+      # @api public
       attr_accessor :cache_editable_workspaces
 
       # Include ReCaptcha tags in user registration form and validate the captcha
       # when creating a new user registration (default: true).
+      # @api public
       attr_accessor :use_recaptcha_on_user_registration
 
       # define a non-default blob cache dir.
-      # `fiona connector` only. has no effect when used with the `cloud connector`.
+      # +fiona connector+ only. has no effect when used with the +cloud connector+.
+      # @api public
       attr_accessor :blob_cache_dir
 
       # Configuration for Content Read Service API.
+      # @api public
       attr_reader :content_service
 
+      # default options for {SearchRequest}
+      # @api public
       def search_options
         @search_options || local_config_file["search"].symbolize_keys
       end
 
+      # default options for CMS API
+      # @api public
       def cms_api_options
         @cms_api_options || local_config_file["cms_api"].symbolize_keys
       end
 
-      def mode=(new_mode) #:nodoc:#
+      # @api public
+      def mode=(new_mode)
         new_mode = new_mode.to_sym
         raise ArgumentError, "Unknown Mode #{new_mode}" unless [:editor, :preview, :live].include?(new_mode)
         @mode = new_mode
       end
 
-      def mode #:nodoc:#
+      # there are three available modes for the rails connector:
+      # <tt>live</tt> (show released contents only),
+      # <tt>preview</tt> (show edited contents)
+      # <tt>editor</tt> (show edited contents and editor interface (e.g. edit markers))
+      # Default mode is <tt>live</tt>.
+      # @api public
+      def mode
         @mode || DEFAULT_MODE
       end
 
       #
       # Sets the array of fields which the +DefaultUserController+ will store in the session.
-      # Defaults to +DEFAULT_STORE_USER_ATTRS_IN_SESSION+.
+      # Defaults to {DEFAULT_STORE_USER_ATTRS_IN_SESSION}.
       #
+      # @api public
       attr_writer :store_user_attrs_in_session
 
       #
-      # Returns fields which the +DefaultUserController+ stores in the session.
+      # Returns fields which the {DefaultUserController} stores in the session.
+      # Defaults to {DEFAULT_STORE_USER_ATTRS_IN_SESSION}.
       #
+      # @api public
       def store_user_attrs_in_session
         @store_user_attrs_in_session || DEFAULT_STORE_USER_ATTRS_IN_SESSION
       end
 
-      def editor_interface_enabled? #:nodoc:#
+      def editor_interface_enabled?
         mode == :editor
       end
 
-      def use_edited_content? #:nodoc:#
+      def use_edited_content?
         mode == :preview || mode == :editor
       end
 
-      def register_features(*features) #:nodoc:
+      def register_features(*features)
         features.each do |f|
           @features.merge!(f.to_sym => false)
         end
       end
       alias :register_feature :register_features
 
-      def registered_features #:nodoc:
+      def registered_features
         @features.keys
       end
 
@@ -108,6 +133,7 @@ module RailsConnector
       #     :crm
       #   )
       #
+      # @api public
       def enable(*features)
         features.each do |f|
           assert_feature_is_known(f)
@@ -126,11 +152,12 @@ module RailsConnector
       #
       # Example call as to be used in <tt>rails_connector.rb</tt>:
       #   RailsConnector::Configuration.instance_name = 'internet'
+      # @api public
       def instance_name=(name)
         RailsConnector::CmsBaseModel.instance_name = name
       end
 
-      def after_initialize #:nodoc:
+      def after_initialize
         enable_authentication
         # Hier muss explizit der Namespace verwendet werden, da diese Methode von Rails
         # während der Initialisierung aufgerufen wird.
@@ -139,7 +166,7 @@ module RailsConnector
         )
       end
 
-      def to_prepare #:nodoc:
+      def to_prepare
         unless Rails.configuration.cache_classes
           after_initialize
           NamedLink.reset_cache
@@ -152,6 +179,7 @@ module RailsConnector
           CmsBaseModel.configure_database("cms")
         elsif local_config_file.configured? 'content_service'
           @content_service = local_config_file['content_service']
+          Blob.configure(:type => 'service')
         else
           CmsBaseModel.configure_database(local_config_file["cms_database"])
           blob_storage_config = local_config_file["cms_blob_storage"]
@@ -168,41 +196,42 @@ module RailsConnector
         end
       end
 
-      attr_accessor :choose_homepage_callback #:nodoc:
+      attr_accessor :choose_homepage_callback
 
       # 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.
+      # @api public
       def choose_homepage(&block)
         self.choose_homepage_callback = block
       end
 
-      def license #:nodoc:
+      def license
         license_file.read
       end
 
-      def license_file #:nodoc:
+      def license_file
         @license_file.presence || Rails.root + "config" + "license.xml"
       end
 
-      def license_file=(license_file) #:nodoc:
+      def license_file=(license_file)
         @license_file = license_file.presence && Pathname(license_file)
       end
 
-      def cms_routes(*args) #:nodoc:
+      def cms_routes(*args)
         raise <<-EOS.gsub(/\s+/, ' ')
         Calling RailsConnector::Configuration.cms_routes is not needed anymore.
         Please remove it from config/routes.rb
         EOS
       end
 
-      def use_x_sendfile=(value) #:nodoc:
+      def use_x_sendfile=(value)
         raise 'Configuration.use_x_sendfile is now available as Rails configuration:'\
               ' config.action_dispatch.x_sendfile_header = "X-Sendfile"'
       end
 
-      def initialize_addon_mixins #:nodoc:
+      def initialize_addon_mixins
         ::ApplicationController.__send__(:helper, :cms)
         if enabled?(:search)
           require "rails_connector/ses"
@@ -214,16 +243,16 @@ module RailsConnector
         ::Obj.__send__(:include, RailsConnector::Rateable) if enabled?(:ratings)
       end
 
-      def local_config_file #:nodoc:
+      def local_config_file
         @local_config_file ||= read_local_config_file
       end
 
-      def local_config_file_name #:nodoc:
+      def local_config_file_name
         (Rails.root + "config/rails_connector.yml").expand_path
       end
 
       # for test purposes only
-      def reset_local_config_file_cache #:nodoc:
+      def reset_local_config_file_cache
         @local_config_file = nil
       end
 
@@ -261,11 +290,11 @@ module RailsConnector
         config
       end
 
-      def assert_feature_is_known(f) #:nodoc:
+      def assert_feature_is_known(f)
         raise ArgumentError, "unknown feature: #{f.inspect}" unless @features.keys.include?(f.to_sym)
       end
 
-      def enable_authentication #:nodoc:
+      def enable_authentication
         # Wenn das OMC-Features an ist, dann braucht man keine Standardimplementierung
         # für die Authentifizierung.
         unless enabled?(:crm)
@@ -285,6 +314,6 @@ module RailsConnector
     )
   end
 
-  class ConfigurationError < StandardError # :nodoc:
+  class ConfigurationError < StandardError
   end
 end

data/lib/rails_connector/core_extensions/time.rb

@@ -1,4 +1,4 @@
-class Time #:nodoc:
+class Time
 
   # Returns a new Time created from the ISO date format String "YYYYMMDDhhmmss"
   def self.from_iso(t)

data/lib/rails_connector/crm.rb

@@ -1,16 +1,17 @@
 module RailsConnector
 
-  # This module provides high-level access to the Infopark Online Marketing Cockpit.
+  # This module provides high-level access to the Infopark WebCRM.
   #
-  # Methods from the +AuthenticationSupport+ module are included
+  # Methods from the {AuthenticationSupport} module are included
   # in all controllers when enabling the Crm feature in your RailsConnector configuration:
   #
   #   RailsConnector::Configuration.enable(
   #     :crm
   #   )
+  # @api public
   module Crm
 
-    # This method requires the omc_connector gem.
+    # This method requires the infopark_crm_connector gem.
     #
     # If the gem is available, it does the following:
     #  * require it
@@ -19,32 +20,31 @@ module RailsConnector
     #  * adds a class-inheritable array to +ApplicationController+ for convenience
     #    (see +session_attributes_for+)
     #
-    # If not, it raises a +LoadError+.
-    def self.enable #:nodoc:
+    # If not, it raises a {LoadError}.
+    def self.enable
       require 'infopark_crm_connector'
       ApplicationController.__send__(:include, AuthenticationSupport)
     end
 
+    # @api public
     module AuthenticationSupport
 
       protected
 
-      def self.included(base) # :nodoc:
+      def self.included(base)
         base.helper_method :logged_in?, :current_user, :admin?
       end
 
-      #
       # Returns a hash of attributes for the given user that are to be stored in the session.
       #
-      # Uses the array +RailsConnector::Configuration.store_user_attrs_in_session+ to determine which
+      # Uses the array {RailsConnector::Configuration.store_user_attrs_in_session} to determine which
       # fields to store.
       # Because the field <tt>:id</tt> must always be stored in the session, it is always in the array
-      # returned by +session_attributes_for+, independent on the fields specified by
-      # +RailsConnector::Configuration.store_user_attrs_in_session+.
+      # returned by {session_attributes_for}, independent on the fields specified by
+      # {RailsConnector::Configuration.store_user_attrs_in_session}.
       #
       # User live_server_groups are stored in the session by default.
-      #
-      def session_attributes_for(user) # :nodoc:
+      def session_attributes_for(user)
         attributes = {}
         serialized_attributes = \
             user.attributes.merge(:live_server_groups => user.live_server_groups).symbolize_keys
@@ -57,16 +57,18 @@ module RailsConnector
 
       # Determines if the user is logged in.
       # Defined as helper method in +ApplicationController+ when enabling the Crm feature.
+      # @return bool
+      # @api public
       def logged_in?
         !session[:user].blank?
       end
 
-      #
       # Returns a +Contact+ object with attributes stored in the session.
       #
-      # To change which fields +DefaultUserController+ stores in the session use
-      # +RailsConnector::Configuration.store_user_attrs_in_session+.
-      #
+      # To change which fields {DefaultUserController} stores in the session use
+      # {RailsConnector::Configuration.store_user_attrs_in_session}.
+      # @return [Infopark::Crm::Contact]
+      # @api public
       def current_user
         @current_user ||= if logged_in?
           user_session = session[:user].dup
@@ -80,6 +82,9 @@ module RailsConnector
       # Takes a +Contact+ object and stores its user attributes in the session.
       #
       # This can be helpful if you want to set a user for e.g. Googlebot.
+      # @param [Infopark::Crm::Contact] user
+      # @return [void]
+      # @api public
       def current_user=(user)
         @current_user = user
         session[:user] = user.nil? ? nil : session_attributes_for(user)
@@ -87,6 +92,8 @@ module RailsConnector
 
       # Reloads the +Contact+ object in +current_user+ from the WebCRM,
       # and updates the user attribute cached in the session.
+      # @return [void]
+      # @api public
       def reload_current_user
         user = current_user
         user.reload
@@ -94,10 +101,10 @@ module RailsConnector
       end
 
       # Determines if the current user is admin (+false+ by default).
-      # Being admin eables to user to delete comments and reset ratings.
+      # Being admin enables to user to delete comments and reset ratings.
       # Defined as helper method in +ApplicationController+ when enabling the CRM feature.
       #
-      # To change the default behavior overwride <tt>admin?</tt> in your ApplicationController.
+      # To change the default behavior overwrite <tt>admin?</tt> in your ApplicationController:
       #
       #   class ApplicationController < ActionController::Base
       #
@@ -108,13 +115,14 @@ module RailsConnector
       #     end
       #
       #   end
+      # @return bool
+      # @api public
       def admin?
         false
       end
 
     end
 
-    # :stopdoc:
     module Localizable
       # --------------------------------------------
       # This module can be included in controllers
@@ -131,9 +139,7 @@ module RailsConnector
         Infopark::Crm.configure {|config| config.locale = I18n.locale.to_s }
       end
     end
-    # :startdoc:
 
-    # :stopdoc:
     module Sanitization
       # --------------------------------------------
       # This module is included in controllers to
@@ -159,85 +165,88 @@ module RailsConnector
         source_hash.reject { |key, value| !allowed_keys.include?(key) }
       end
     end
-    # :startdoc:
 
-    # This module is included in +DefaultUserController+ to provide callbacks for user functionality.
+    # This module is included in {DefaultUserController} to provide callbacks for user functionality.
     #
     # If you want to add behavior before or after authentication, logout or register, override any of
-    # the methods included in this module in your +UserController+.
+    # the methods included in this module in your {UserController}.
+    # @api public
     module Callbacks
 
-      # :stopdoc:
-      # --------------------------------------------
-      # This module is documented in sections
-      # because RDoc orders methods alphabetically,
-      # which doesn't make sense here.
-      # --------------------------------------------
-      # :startdoc:
-
       private
 
-      # :section: "Before" callbacks
+      # @!group Callbacks
 
-      # Called by +DefaultUserController+ on POST requests before a user is authenticated,
+      # Called by {DefaultUserController} on POST requests before a user is authenticated,
       # i.e. the user has already provided credentials in a form.
       #
       # By default, it doesn't do anything.
+      # @return [void]
+      # @api public
       def before_authenticate
       end
 
-      # Called by +DefaultUserController+ before a user is logged out,
+      # Called by {DefaultUserController} before a user is logged out,
       # i.e. the session is reset.
       #
       # By default, it doesn't do anything.
+      # @return [void]
+      # @api public
       def before_logout
       end
 
-      # Called by +DefaultUserController+ on POST requests before a user is created,
+      # Called by {DefaultUserController} on POST requests before a user is created,
       # i.e. the user has already provided name, e-mail etc. in a form.
       #
       # By default, it doesn't do anything.
+      # @return [void]
+      # @api public
       def before_register
       end
 
-      # :section: "After" callbacks
-
-      # Called by +DefaultUserController+ on POST requests after a user is authenticated,
+      # Called by {DefaultUserController} on POST requests after a user is authenticated,
       # i.e. the user has already provided correct credentials but the session has not yet been set.
       #
       # By default, it doesn't do anything.
+      # @return [void]
+      # @api public
       def after_authenticate
       end
 
-      # Called by +DefaultUserController+ after a user is logged out,
+      # Called by {DefaultUserController} after a user is logged out,
       # i.e. the session is reset.
       #
       # By default, it doesn't do anything.
+      # @return [void]
+      # @api public
       def after_logout
       end
 
-      # Called by +DefaultUserController+ on POST requests after a user is created,
+      # Called by {DefaultUserController} on POST requests after a user is created,
       # i.e. a WebCRM activity has been created or the user has been created directly in the WebCRM.
       #
       # By default, it doesn't do anything.
+      # @return [void]
+      # @api public
       def after_register
       end
 
-      # :section: WebCRM error handling
-
-      # Called by +DefaultUserController+ whenever requests to the WebCRM fail.
+      # Called by {DefaultUserController} whenever requests to the WebCRM fail.
       # This includes <tt>Errno::ECONNREFUSED</tt> or the ActiveResource errors +ForbiddenAccess+,
       # +UnauthorizedAccess+, and +BadRequest+.
       #
       # By default, it raises an error so that administrators are notified immediately
       # if the WebCRM is down or not configured properly.
+      # @return [void]
+      # @api public
       def on_crm_error(exception)
         raise exception
       end
 
+      # @!endgroup
+
     end
 
-    # :stopdoc:
     # Default attributes for WebCRM's Contact.
     #
     # Helpers like +form_for+ will fail on +ActiveResource+ attributes
@@ -275,7 +284,6 @@ module RailsConnector
       :want_phonecall => 0,
       :want_snailmail => 0
     }.stringify_keys
-    # :startdoc:
 
   end
 

data/lib/rails_connector/engine.rb

@@ -7,7 +7,7 @@ require 'jquery-rails'
 require 'rails_connector/configuration'
 
 module ::RailsConnector
-  class Engine < Rails::Engine #:nodoc:
+  class Engine < Rails::Engine
     config.to_prepare { RailsConnector::Configuration.to_prepare }
     config.after_initialize { RailsConnector::Configuration.after_initialize }
 

data/lib/rails_connector/fop.rb

@@ -6,9 +6,9 @@ module RailsConnector
     #
     class GenerationFailed < RuntimeError; end
 
-    CMD = 'fop -xml "%s" -xsl "%s" -pdf "%s" 2>&1' # :nodoc:
+    CMD = 'fop -xml "%s" -xsl "%s" -pdf "%s" 2>&1'
 
-    def self.generate_pdf(xml, xsl, pdf) # :nodoc:
+    def self.generate_pdf(xml, xsl, pdf)
       output = `#{CMD % [xml, xsl, pdf]}`
       unless `file -pb "#{pdf}"`.include?('PDF')
         raise GenerationFailed, output

data/lib/rails_connector/fop_on_rails/document/dom_tree.rb

@@ -3,7 +3,7 @@ require "rexml/document"
 
 module RailsConnector
   module FopOnRails
-    module Document # :nodoc: all
+    module Document
       module DomTree
         TIDY_CONF = {
           'clean' => true,

data/lib/rails_connector/fop_on_rails/document/images.rb

@@ -1,6 +1,6 @@
 module RailsConnector
   module FopOnRails
-    module Document # :nodoc: all
+    module Document
       module Images
         def self.absolutize_src_attrs(xml, url)
           @url = URI.parse(url)

data/lib/rails_connector/fop_on_rails/document/tables.rb

@@ -1,6 +1,6 @@
 module RailsConnector
   module FopOnRails
-    module Document # :nodoc: all
+    module Document
       module Tables
         def self.repair(xml)
           xml.elements.each '//table' do |table|

data/lib/rails_connector/fop_on_rails/document.rb

@@ -4,7 +4,7 @@ require 'rails_connector/fop_on_rails/document/tables'
 
 module RailsConnector
   module FopOnRails
-    module Document # :nodoc: all
+    module Document
       def self.repair(path, xml_uri = nil)
         xml = DomTree.repair(File.read(path))
 

data/lib/rails_connector/fop_on_rails.rb

@@ -19,12 +19,12 @@ module RailsConnector
     # the PDF is generated.
     #
     # If the download of <code>xml_location</code> or <code>xsl_location</code> fails, then
-    # the <code>RailsConnector::FopOnRails::DownloadError</code> is raised.
+    # the {RailsConnector::FopOnRails::DownloadError} is raised.
     #
     # To generate a PDF, the given XML <b>must</b> be valid. If for some reasons it is not, then you can use the
     # <code>tidy</code> option to repair it.
     #
-    # If the PDF generation fails, then the <code>RailsConnector::Fop::GenerationFailed</code> error
+    # If the PDF generation fails, then the {RailsConnector::Fop::GenerationFailed} error
     # is raised.
     #
     # Example:

data/lib/rails_connector/googlebot_checker.rb

@@ -1,4 +1,3 @@
-#:stopdoc:
 module RailsConnector
 
   module GooglebotChecker

data/lib/rails_connector/html_string.rb

@@ -1,7 +1,7 @@
 module RailsConnector
 
   # Include this module in order to tag the string as one with HTML content
-  module HtmlString #:nodoc:
+  module HtmlString
     include LinkResolvable
     # Returns whether the String contains HTML (default to true, overrides String.html?).
     def html?
@@ -11,7 +11,7 @@ module RailsConnector
 
 end
 
-class String #:nodoc:
+class String
   # Returns whether the String contains HTML (default to false).
   def html?
     false

data/lib/rails_connector/link_resolvable.rb

@@ -1,6 +1,6 @@
 module RailsConnector
 
-  module LinkResolvable #:nodoc:
+  module LinkResolvable
     attr_accessor :source
 
   end

data/lib/rails_connector/liquid_support/field_value_drop.rb

@@ -1,6 +1,6 @@
 module RailsConnector::LiquidSupport
 
-  class FieldValueDrop < Liquid::Drop #:nodoc:
+  class FieldValueDrop < Liquid::Drop
     attr_accessor :__value, :__marker
 
     def initialize(obj, field, value, marker)

data/lib/rails_connector/liquid_support/link_drop.rb

@@ -1,7 +1,7 @@
 module RailsConnector::LiquidSupport
 
   # Dieser Drop kapselt einen Link.
-  class LinkDrop < Liquid::Drop #:nodoc:
+  class LinkDrop < Liquid::Drop
     def initialize(link)
       @link = link
     end