infopark_rails_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/.yardopts

@@ -0,0 +1,5 @@
+--hide-void-return
+--protected
+--private
+--non-transitive-tag api
+--api public

data/README

@@ -1,17 +1,19 @@
 = Infopark Rails Connector
 
-Infopark Rails Connector allows you to integrate a number of ready-to-run features into your Rails application.
+Infopark Rails Connector integrates Infopark’s CMS into your Rails application.
+
+It connects either to Infopark Cloud Express CMS via {https://rubygems.org/gems/infopark_cloud_connector infopark_cloud_connector} or to Infopark CMS Fiona via {https://rubygems.org/gems/infopark_fiona_connector infopark_fiona_connector}. It also enables you to integrate various ready-to-run features.
+
+For more information about Infopark Rails Connector, please visit {http://kb.infopark.de/ Infopark’s Knowledge Base}.
 
 == Configuration
-Here is how all available addons would be enabled in the <tt>rails_connector.rb</tt> initializer file of your application:
+Here is how all available addons can be enabled in the <tt>rails_connector.rb</tt> initializer file of your application:
 
   RailsConnector::Configuration.enable(
-    :comments,
     :google_analytics,
     :infopark_tracking,
-    :omc,
+    :crm,
     :pdf_generator,
-    :ratings,
     :rss,
     :search,
     :seo_sitemap,
@@ -37,23 +39,10 @@ That helper is to be put right before the closing body tag.
 == Generators
 Infopark Rails Connector comes with three generators to help you get up and running quickly:
 
-<tt>rails generate rails_connector:install</tt>
+  > rails generate rails_connector:install
 
 Adds Time machine assets, a +rails_connector.rb+ initializer and rake tasks specific to the gem to your application.
 
-<tt>rails generate rails_connector:comments</tt>
-
-Specific to the +comments+ feature. Adds a comments migration to your application.
-
-<tt>rails generate rails_connector:ratings</tt>
-
-Specific to the +ratings+ feature. Adds a ratings migration to your application as well as an example stylesheet and background image.
-
-== Infopark Tracking
-
-If you enable the infopark_tracking, please refer to the OMC documentation for further details,
-e.g. Apache logging options.
-
 == Seo Sitemap
 
-The default implementation for the seo sitemap will feature all files from your CMS in the generated <tt>sitemap.xml</tt>. For a large number of files, this can slow down your server. Please refer to <tt>RailsConnector::SEO::ClassMethods#find_all_for_sitemap</tt> for advise on optimization.
+The default implementation for the seo sitemap will feature all files from your CMS in the generated <tt>sitemap.xml</tt>. For a large number of files, this can slow down your server. Please refer to {RailsConnector::SEO::ClassMethods#find_all_for_sitemap} for advise on optimization.

data/app/controllers/cms_controller.rb

@@ -1,6 +1,7 @@
 # This controller inherits all of its behavior from
-# RailsConnector::DefaultCmsController.
+# {RailsConnector::DefaultCmsController}.
 #
-# CmsController is referenced by the Rails Connector routes.
+# {CmsController} is referenced by the Rails Connector routes.
+# @api public
 class CmsController < RailsConnector::DefaultCmsController
 end

data/app/controllers/comments_controller.rb

@@ -1,6 +1,6 @@
 # This controller inherits all of its behavior from
-# RailsConnector::DefaultCommentsController.
+# {RailsConnector::DefaultCommentsController}.
 #
-# CommentsController is referenced by the Rails Connector routes.
+# {CommentsController} is referenced by the Rails Connector routes.
 class CommentsController < RailsConnector::DefaultCommentsController
 end

data/app/controllers/crm_form_controller.rb

@@ -1,2 +1,7 @@
+# This controller inherits all of its behavior from
+# {RailsConnector::DefaultCrmFormController}.
+#
+# {CrmFormController} is referenced by the Rails Connector routes.
+# @api public
 class CrmFormController < RailsConnector::DefaultCrmFormController
 end

data/app/controllers/pdf_controller.rb

@@ -2,5 +2,6 @@
 # RailsConnector::DefaultPdfController.
 #
 # PdfController is referenced by the Rails Connector routes.
+# @api public
 class PdfController < RailsConnector::DefaultPdfController
 end

data/app/controllers/rails_connector/default_cms_controller.rb

@@ -1,9 +1,10 @@
 module RailsConnector
 
-  # This controller provides some default includes (+CmsAccessible+),
+  # This controller provides some default includes ({CmsAccessible}),
   # before filters (+load_object+, among others), and actions to simplify
   # CMS object handling. It should never be used directly, but only as a
-  # super class to CmsController.
+  # super class to {CmsController}.
+  # @api public
   class DefaultCmsController < ApplicationController
     include CmsAccessible
     before_filter :set_preview_time
@@ -13,11 +14,13 @@ module RailsConnector
     before_filter :set_google_expire_header
 
     # Default Action. Delivers files directly if their mime type is not text/html
+    # @api public
     def index
       deliver_file if @obj.mime_type != "text/html"
     end
 
     # Toggles edit markers. The current status is stored in the session.
+    # @api public
     def toggle_editmarkers
       session[:hide_editmarkers] = !session[:hide_editmarkers]
       redirect_to cms_id_url(@obj)
@@ -28,10 +31,11 @@ module RailsConnector
     #
     # Overwrite it to return false if you do want your controller to be excluded from Obj dispatching.
     #
-    # You may also implement a method with the name +use_for_obj_dispatch?+ in controllers not
-    # descending from +DefaultCmsController+ to include them in Obj dispatching.
+    # You may also implement a method with the name {use_for_obj_dispatch?} in controllers not
+    # descending from {DefaultCmsController} to include them in Obj dispatching.
     #
     # @see Obj#controller_name
+    # @api public
     def self.use_for_obj_dispatch?
       true
     end

data/app/controllers/rails_connector/default_comments_controller.rb

@@ -1,10 +1,9 @@
 module RailsConnector
   #
   # This class provides a default controller implementation for comment creation.
-  # It should only be used indirectly via a subclass named CommentsController.
+  # It should only be used indirectly via a subclass named {CommentsController}.
   #
   # The controller actions only respond to XMLHttpRequests (Ajax).
-  #
   class DefaultCommentsController < ApplicationController
     layout nil
 

data/app/controllers/rails_connector/default_crm_form_controller.rb

@@ -1,6 +1,7 @@
 module RailsConnector
   # This class provides a default controller implementation for WebCRM form using custom attributes.
   # It should be customized by subclassing.
+  # @api public
   class DefaultCrmFormController < DefaultCmsController
 
     include Crm::Localizable
@@ -13,6 +14,7 @@ module RailsConnector
       :contact => [:gender, :first_name, :last_name, :email]
     }
 
+    # @api public
     def index
       unless logged_in?
         @user = Infopark::Crm::Contact.new(:language => default_language)
@@ -46,6 +48,7 @@ module RailsConnector
     # Override this method for custom logic to get from a given OBJ to an activity kind.
     #
     # Defaults to +@obj[:activity_kind]+ or 'contact form' if the former is +nil+.
+    # @api public
     def activity_kind
       @obj[:activity_kind] || 'contact form'
     end
@@ -53,6 +56,7 @@ module RailsConnector
     # Returns the state of a new activity.
     #
     # Defaults to the first state assigned to +activity_kind+.
+    # @api public
     def activity_state
       Infopark::Crm::CustomType.find(activity_kind).states.first
     end
@@ -64,6 +68,7 @@ module RailsConnector
     # an additional form field to the corresponding view.
     #
     # Defaults to the current locale.
+    # @api public
     def default_language
       I18n.locale.to_s
     end
@@ -75,6 +80,7 @@ module RailsConnector
     # the behavior without having to override #index.
     #
     # By default, it assigns a default title if +has_title_input_field?+ is +false+.
+    # @api public
     def before_saving_activity(activity)
       activity.title = "Website form submission" unless has_title_input_field?
     end
@@ -86,6 +92,7 @@ module RailsConnector
     # The method is also available as helper in your views.
     #
     # By default, it renders crm_form/confirmation
+    # @api public
     def after_saving_activity(activity)
       render 'crm_form/confirmation'
     end
@@ -94,6 +101,7 @@ module RailsConnector
     # Override this method to return +false+ if you want to set the title programmatically.
     #
     # By default, it returns +true+
+    # @api public
     def has_title_input_field?
       true
     end
@@ -105,6 +113,7 @@ module RailsConnector
     # and custom attributes that are not to be set by users.
     #
     # By default, it returns a hash only with title and custom values.
+    # @api public
     def sanitize_activity_params(activity_params_or_nil)
       activity_params_whitelist = [:title]
       (activity_params_or_nil || {}).reject do |attr, value|
@@ -118,6 +127,7 @@ module RailsConnector
     #
     # Drop a custom view to change the look, or override this method
     # if you want different behavior, like a redirect.
+    # @api public
     def authorize
       render 'not_logged_in' unless logged_in? || allow_anonymous?
     end
@@ -129,6 +139,7 @@ module RailsConnector
     # The method is also available as helper in your views.
     #
     # By default, it returns +false+, i.e. only logged-in users can see the form
+    # @api public
     def allow_anonymous?
       false
     end
@@ -141,6 +152,7 @@ module RailsConnector
     #
     # By default, it returns +true+ for any attribute, i.e. every custom attribute
     # can be filled in by the user.
+    # @api public
     def allow_custom_attribute?(attribute_name)
       true
     end
@@ -159,6 +171,7 @@ module RailsConnector
     #     }
     #
     #   end
+    # @api public
     def editable_attributes_on_register
       self.class.editable_attributes_on_register
     end

data/app/controllers/rails_connector/default_pdf_controller.rb

@@ -58,6 +58,7 @@ module RailsConnector
   # "white list", then an error message will be rendered as inline text with response status "403
   # Forbidden".
   #
+  # @api public
   class DefaultPdfController < DefaultCmsController
     # Returns false by default to exclude this controller from regular Obj dispatch.
     # @see DefaultCmsController#use_for_obj_dispatch?
@@ -92,6 +93,7 @@ module RailsConnector
     #   <%= link_to 'Generate PDF', pdf_path(@obj) %>
     #   # This will generate a PDF containing the title and the body of the current object
     #
+    # @api public
     def index
     end
 

data/app/controllers/rails_connector/default_rss_controller.rb

@@ -8,12 +8,15 @@ module RailsConnector
   # Specify the RSS root in
   # <code><em>RAILS_ROOT</em>/config/initializers/rails_connector.rb</code>:
   #   RailsConnector::Configuration::Rss.root = lambda { NamedLink.get_object('news') }
+  # @api public
   class DefaultRssController < DefaultCmsController
     #
     # This action renders the built-in RSS feed.
     #
     # To customize feed's layout, override either this method, or the apropriate view.
     #
+    # @return [void]
+    # @api public
     def index
       respond_to do |format|
         format.rss
@@ -22,7 +25,7 @@ module RailsConnector
 
     protected
 
-    def load_object # :nodoc:
+    def load_object
       @obj = Configuration::Rss.root
     end
   end

data/app/controllers/rails_connector/default_search_controller.rb

@@ -4,6 +4,7 @@ module RailsConnector
 
   # This class provides a default controller implementation for searching.
   # It should be customized by subclassing.
+  # @api public
   class DefaultSearchController < ApplicationController
     class_attribute :options
     self.options = {:limit => 10}
@@ -27,6 +28,7 @@ module RailsConnector
     #       #  * Flash on errors
     #     end
     #   end
+    # @api public
     def search
       unless (@query = params[:q]).blank?
         @hits = WillPaginate::Collection.create(current_page, options[:limit]) do |pager|

data/app/controllers/rails_connector/default_user_controller.rb

@@ -14,6 +14,7 @@ module RailsConnector
   # This can be done in your <tt>rails_connector.rb</tt> or in +UserController+ directly.
   #
   # By default, users can submit their first name, last name, email and company name.
+  # @api public
   class DefaultUserController < ApplicationController
 
     before_filter :check_editable_attribute_configuration
@@ -44,6 +45,7 @@ module RailsConnector
     end
 
     # Displays a profile page containing links to all available actions
+    # @api public
     def profile
     end
 
@@ -61,6 +63,7 @@ module RailsConnector
     #
     # If you merely want to change what happens before or after a user is authenticated,
     # do not override this method but override +before_authenticate+ or +after_authenticate+.
+    # @api public
     def login
       if request.post?
         @user = Infopark::Crm::Contact.new(params[:user] || {:login => nil, :password => nil})
@@ -87,6 +90,7 @@ module RailsConnector
     #
     # To change the behavior before or after invalidating the session,
     # override +before_logout+ or +after_logout+.
+    # @api public
     def logout
       before_logout
       self.current_user = nil
@@ -100,6 +104,7 @@ module RailsConnector
     #
     # If you merely want to change what happens before or after a user is registered,
     # do not override this method but override +before_register+ or +after_register+.
+    # @api public
     def new
       @user = Infopark::Crm::Contact.new
       # Load some default attributes so that form_for is working
@@ -119,10 +124,12 @@ module RailsConnector
       flash.now[:error] = tcon('registration_failed')
     end
 
+    # @api public
     def register_pending
     end
 
     # Lets the user change his/her user details.
+    # @api public
     def edit
       @user = Infopark::Crm::Contact.find(current_user.id)
       if request.post? || request.put?
@@ -138,6 +145,7 @@ module RailsConnector
     # Lets the user change his/her password.
     #
     # Validates the new password using +validate_edit_password_params_for+.
+    # @api public
     def edit_password
       if request.post?
         validate_edit_password_params_for(params[:user])
@@ -153,6 +161,7 @@ module RailsConnector
     # Lets the user request a new password (double opt-in).
     #
     # Uses the +ConfirmationMailer+ for sending out the confirmation message.
+    # @api public
     def forgot_password
       if request.post?
         user = Infopark::Crm::Contact.search(:params => {:login => params[:user][:login]}).first
@@ -167,6 +176,7 @@ module RailsConnector
       end
     end
 
+    # @api public
     def set_password
       if request.get? && params[:token].blank?
         flash[:error] = tcon('token_url_invalid')

data/app/controllers/rails_connector/pdf_external_controller.rb

@@ -1,5 +1,6 @@
 module RailsConnector
-  class PdfExternalController < ApplicationController # :nodoc: all
+
+  class PdfExternalController < ApplicationController
     skip_before_filter :verify_authenticity_token
     before_filter :validate_inputs
 

data/app/controllers/rails_connector/time_machine_controller.rb

@@ -1,6 +1,6 @@
 module RailsConnector
 
-  class TimeMachineController < ApplicationController #:nodoc:
+  class TimeMachineController < ApplicationController
 
     protect_from_forgery :except => :set_preview_time
 

data/app/controllers/rss_controller.rb

@@ -2,5 +2,6 @@
 # RailsConnector::DefaultRssController.
 #
 # RssController is referenced by the Rails Connector routes.
+# @api public
 class RssController < RailsConnector::DefaultRssController
 end

data/app/controllers/search_controller.rb

@@ -1,2 +1,7 @@
+# This controller inherits all of its behavior from
+# {RailsConnector::DefaultSearchController}.
+#
+# {SearchController} is referenced by the Rails Connector routes.
+# @api public
 class SearchController < RailsConnector::DefaultSearchController
 end

data/app/controllers/seo_sitemap_controller.rb

@@ -1,9 +1,11 @@
 # Renders a search engine optimized sitemap.xml
 # Enable via <tt>RailsConnector::Configuration.enable(:seo_sitemap)</tt>
+# @api public
 class SeoSitemapController < ApplicationController
   layout nil
 
   # Finds all objects which are to be shown in the SEO sitemap. Responds to xml only.
+  # @api public
   def show
     @objects = Obj.find_all_for_sitemap
     respond_to { |format| format.xml }

data/app/controllers/user_controller.rb

@@ -1,2 +1,7 @@
+# This controller inherits all of its behavior from
+# {RailsConnector::DefaultUserController}.
+#
+# {UserController} is referenced by the Rails Connector routes.
+# @api public
 class UserController < RailsConnector::DefaultUserController
 end

data/app/helpers/cms_helper.rb

@@ -1,6 +1,7 @@
-# CmsHelper is a wrapper around RailsConnector::DefaultCmsHelper.
+# {CmsHelper} is a wrapper around {RailsConnector::DefaultCmsHelper}.
 # It can be replaced in your application in order to add or
 # modify helpers.
+# @api public
 module CmsHelper
   include RailsConnector::DefaultCmsHelper
 end

data/app/helpers/cms_routing_helper.rb

@@ -1,6 +1,7 @@
-# CmsRoutingHelper is a wrapper around RailsConnector::DefaultCmsRoutingHelper.
+# {CmsRoutingHelper} is a wrapper around {RailsConnector::DefaultCmsRoutingHelper}.
 # It can be replaced in your application in order to add or
 # modify helpers.
+# @api public
 module CmsRoutingHelper
   include RailsConnector::DefaultCmsRoutingHelper
 end

data/app/helpers/crm_form_helper.rb

@@ -1,3 +1,7 @@
+# {CrmFormHelper} is a wrapper around {RailsConnector::DefaultCrmFormHelper}.
+# It can be replaced in your application in order to add or
+# modify helpers.
+# @api public
 module CrmFormHelper
   include RailsConnector::DefaultCrmFormHelper
 end

data/app/helpers/rails_connector/cms_asset_helper.rb

@@ -5,6 +5,7 @@ module RailsConnector
   # Use this helper to take advantage of rails' asset host mechanism.
   # (See http://api.rubyonrails.com/classes/ActionView/Helpers/AssetTagHelper.html for details about asset hosts.)
   # If your application does not use any asset hosts, the helper will generate regular (=non asset host) pathes.
+  # @api public
   module CmsAssetHelper
 
     # Returns an html image tag for an image stored in the CMS.
@@ -16,6 +17,7 @@ module RailsConnector
     # +target+'s +display_title+ as the html alt attribute.
     # If your application is configured to use asset hosts, the images tag will reference
     # the image using one of your asset hosts.
+    # @api public
     def cms_image_tag(target, options = {})
       options.symbolize_keys!
 
@@ -31,6 +33,7 @@ module RailsConnector
     # +target+ can be an +Obj+ or a +Link+ or a +LinkList+.
     # If your application is configured to use asset hosts, the path will reference
     # the object using one of your asset hosts.
+    # @api public
     def cms_asset_path(target)
       regular_path = cms_path(target)
       return regular_path if regular_path.first == "#"

data/app/helpers/rails_connector/default_cms_helper.rb

@@ -8,7 +8,7 @@ module RailsConnector
   #   module CmsHelper
   #     include RailsConnector::DefaultCmsHelper
   #   end
-
+  # @api public
   module DefaultCmsHelper
     include DisplayHelper
     include MarkerHelper

data/app/helpers/rails_connector/default_cms_routing_helper.rb

@@ -1,11 +1,14 @@
 module RailsConnector
 
+  # @api public
   module DefaultCmsRoutingHelper
     # Returns the path for +target+ using the +CmsController+ routes.
     # +target+ can be an +Obj+ or a +Link+ or a +LinkList+.
     # If +target+ is a +Linklist+, it must be non-empty. The first +Link+ from the +LinkList+ will be used.
     # +options+ are optional and include url settings such as path parameters or protocol
     # +options+ are only passed on if +target+ is an +Obj+.
+    # @return [String]
+    # @api public
     def cms_path(target, options = {})
       cms_path_or_url(target, "path", options)
     end
@@ -15,14 +18,16 @@ module RailsConnector
     # If +target+ is a +Linklist+, it must be non-empty. The first +Link+ from the +LinkList+ will be used.
     # +options+ are optional and include url settings such as path parameters or protocol
     # +options+ are only passed on if +target+ is an +Obj+.
+    # @return [String]
+    # @api public
     def cms_url(target, options = {})
       cms_path_or_url(target, "url", options)
     end
 
-    LINK_TO_UNREACHABLE = "#__target_object_not_reachable" #:nodoc:
-    LINK_TO_EMPTY_LINKLIST = "#__empty_linklist" #:nodoc:
+    LINK_TO_UNREACHABLE = "#__target_object_not_reachable"
+    LINK_TO_EMPTY_LINKLIST = "#__empty_linklist"
 
-    def cms_path_or_url(target, path_or_url, options = {}) #:nodoc:
+    def cms_path_or_url(target, path_or_url, options = {})
       if target.is_a?(Link)
         cms_path_or_url_for_links(target, path_or_url)
       elsif target.is_a?(Obj)
@@ -39,14 +44,14 @@ module RailsConnector
       end
     end
 
-    def cms_path_or_url_for_links(link, path_or_url) #:nodoc:
+    def cms_path_or_url_for_links(link, path_or_url)
       return LINK_TO_UNREACHABLE if link.internal? && link.destination_object.nil?
       append_search_and_fragment(
         basic_url_or_path_for_link(link, path_or_url), link
       )
     end
 
-    def cms_path_or_url_for_objs(obj, path_or_url, options = {}) #:nodoc:
+    def cms_path_or_url_for_objs(obj, path_or_url, options = {})
       permalink = obj.permalink
       if permalink && !Configuration.editor_interface_enabled?
         __send__("cms_permalink_#{path_or_url}", options.merge(:permalink => permalink))

data/app/helpers/rails_connector/default_crm_form_helper.rb

@@ -1,11 +1,13 @@
 module RailsConnector
 
+  # @api public
   module DefaultCrmFormHelper
 
     include ::RailsConnector::DefaultUserHelper
     include ::RailsConnector::MandatoryLabelHelper
     include ::RailsConnector::ErrorMessagesHelper
 
+    # @api public
     def custom_fields_for(form)
       activity = instance_variable_get("@#{form.object_name}")
       custom_attribute_defs = Infopark::Crm::CustomType.find(activity.kind).custom_attributes
@@ -35,6 +37,7 @@ module RailsConnector
       content
     end
 
+    # @api public
     def title_field_for(form)
       content = "".html_safe
       if has_title_input_field?
@@ -48,6 +51,7 @@ module RailsConnector
       content
     end
 
+    # @api public
     def logged_in_as(user)
       content_tag(:em) do
         t('rails_connector.views.crm_form.logged_in_as',

data/app/helpers/rails_connector/default_user_helper.rb

@@ -2,7 +2,8 @@ require "recaptcha"
 
 module RailsConnector
 
-  # This module contains helpers for the +UserController+ and +DefaultUserController+
+  # This module contains helpers for the {UserController} and {DefaultUserController}
+  # @api public
   module DefaultUserHelper
 
     include ::ReCaptcha::ViewHelper
@@ -10,6 +11,7 @@ module RailsConnector
     include ::RailsConnector::ErrorMessagesHelper
 
     # Returns mandatory user fields as array of symbols.
+    # @api public
     def mandatory_user_fields
       [:email, :gender, :language, :last_name]
     end
@@ -38,6 +40,7 @@ module RailsConnector
     #     user:
     #       first_name: First name
     #       last_name: Last name
+    # @api public
     def user_fields_for(form, model_name, *attributes)
       output = "".html_safe
       attributes.flatten.each do |attr|
@@ -63,6 +66,7 @@ module RailsConnector
       output
     end
 
+    # @api public
     def genders_for_select
       [
         ['', 'N'],
@@ -71,6 +75,7 @@ module RailsConnector
       ]
     end
 
+    # @api public
     def languages_for_select_for(*languages)
       options = []
       languages.flatten.each do |lang|
@@ -79,6 +84,7 @@ module RailsConnector
       options
     end
 
+    # @api public
     def profile_fields_for(form, editable_attributes={})
       output = "".html_safe
       output += user_fields_for(form, "contact", editable_attributes[:contact])