infopark_rails_connector 6.8.0.beta.200.621.4c8e1b0

data/config/routes.rb

@@ -0,0 +1,37 @@
+Rails.application.routes.draw do
+  if RailsConnector::Configuration.enabled?(:search)
+    match 'search', :to => 'search#search'
+  end
+
+  if RailsConnector::Configuration.enabled?(:crm)
+    match 'login', :to => 'user#login'
+    match 'logout', :to => 'user#logout'
+    match 'user/:action', :to => 'user', :as => "user"
+  end
+
+  if RailsConnector::Configuration.enabled?(:time_machine) && RailsConnector::Configuration.editor_interface_enabled?
+    match 'time_machine/:action', :to => 'rails_connector/time_machine', :as => "time_machine"
+  end
+
+  if RailsConnector::Configuration.enabled?(:pdf_generator)
+    match 'pdf/external', :to => 'rails_connector/pdf_external#index', :as => "pdf_external"
+    match 'pdf/:id', :to => 'pdf#index', :as => "pdf"
+    match 'pdf/:action/:id', :to => 'pdf', :as => "pdf_with_action"
+  end
+
+  if RailsConnector::Configuration.enabled?(:rss)
+    match 'rss', :to => 'rss#index', :format => "rss"
+  end
+
+  if RailsConnector::Configuration.enabled?(:comments)
+    match 'comments/:action(/:id)', :to => 'comments', :as => "comment"
+  end
+
+  if RailsConnector::Configuration.enabled?(:ratings)
+    match 'ratings/:action/:id(/:score)', :to => 'ratings', :as => "ratings"
+  end
+
+  if RailsConnector::Configuration.enabled?(:seo_sitemap)
+    match 'sitemap.xml', :to => 'seo_sitemap#show', :format => 'xml'
+  end
+end

data/lib/generators/rails_connector/comments/comments_generator.rb

@@ -0,0 +1,21 @@
+#:stopdoc:
+require "rails/generators/active_record"
+
+module RailsConnector
+  module Generators
+    class CommentsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      desc "Create a migration to create comments in your application."
+      def generate_migration
+        migration_template 'migration.rb', 'db/migrate/create_comments.rb'
+      end
+    end
+  end
+end

data/lib/generators/rails_connector/comments/templates/migration.rb

@@ -0,0 +1,17 @@
+# :stopdoc:
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.string :obj_id
+      t.string :name
+      t.string :email
+      t.string :subject
+      t.text :body
+      t.datetime :created_at
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/lib/generators/rails_connector/install/install_generator.rb

@@ -0,0 +1,38 @@
+#:stopdoc:
+module RailsConnector
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy Infopark Rails Connector files to your application."
+
+      # Normally, you'd just call 'source_root' as a class method from here,
+      # but we need to glob the dir ourselves. Hence our own method.
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+      def install_configuration
+        copy_file "initializers/rails_connector.rb", "config/initializers/rails_connector.rb"
+        copy_file "obj_extensions.rb", "lib/obj_extensions.rb"
+        copy_file "local/configuration.rb", "config/local/configuration.rb"
+      end
+
+      def append_asset_manifests
+        append_file("app/assets/javascripts/application.js", "//= require infopark_rails_connector")
+        gsub_file("app/assets/stylesheets/application.css", "*= require_tree .",
+            "*= require_tree .\n *= require infopark_rails_connector")
+      end
+
+      def remove_public_index_html
+        remove_file "public/index.html"
+        remove_file "app/assets/images/rails.png"
+      end
+
+      def patch_default_application_layout
+        gsub_file("app/views/layouts/application.html.erb", %r{</head>},
+            "<%= rails_connector_header_tags %>\n</head>")
+        gsub_file("app/views/layouts/application.html.erb", %r{</body>},
+            "<%= rails_connector_after_content_tags %>\n</body>")
+      end
+    end
+  end
+end

data/lib/generators/rails_connector/install/templates/initializers/rails_connector.rb

@@ -0,0 +1,58 @@
+# Name of the CMS Fiona Instance to access
+RailsConnector::Configuration.instance_name = 'default'
+
+# Enable Rails Connector Addons.
+# Please refer to the Infopark Knowledge Base for more information on addons.
+RailsConnector::Configuration.enable(
+  # :comments,
+  # :google_analytics,
+  # :crm,
+  # :pdf_generator,
+  # :ratings,
+  # :rss,
+  :search,
+  # :seo_sitemap,
+  :time_machine
+)
+
+# Search should be configured in config/rails_connector.yml
+
+# RSS-Feed:
+#
+# Specify which Object should be used for the RSS feed's parent folder
+# RailsConnector::Configuration::Rss.root = lambda { NamedLink.get_object('news') }
+
+
+# PDF-Generator:
+#
+# Set a list of approved hosts which the PdfGenerator is allowed to use
+RailsConnector::Configuration::PdfGenerator.host_whitelist('localhost')
+
+
+# Google Analytics:
+#
+# RailsConnector::Configuration::GoogleAnalytics.domains(
+#   '<your.domain.com>' => '<your-ga-code-1>',
+#   '<your.domain.de>' => '<your-ga-code-2>'
+# )
+
+# OMC:
+#
+# Infopark::Crm.configure do |config|
+#   config.url = "http://<crm-domain>:<port>"
+#   config.login = 'webservice'
+#   config.api_key = '<password>'
+#   # config.live_server_groups_callback = lambda {|contact|
+#   #   case contact.account.name
+#   #   when "My Company"
+#   #     %w(internal)
+#   #   else
+#   #     []
+#   #   end
+#   # }
+# end
+#
+# Re-captcha public/private key pair (used for creating a new user)
+# You can get those by signing up at http://recaptcha.net/
+# RCC_PUB=""
+# RCC_PRIV=""

data/lib/generators/rails_connector/install/templates/local/configuration.rb

@@ -0,0 +1,2 @@
+# Put your local configuration here.
+# Don't forget to configure your SCM to ignore this file.

data/lib/generators/rails_connector/install/templates/obj_extensions.rb

@@ -0,0 +1,25 @@
+module ObjExtensions
+
+  # Infopark Rails Connector enables the developer to define specific behavior for Fiona CMS
+  # classes by using Single Table Inheritance (http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html).
+  #
+  # If you wish to decorate the Obj model with extra behavior, you will need to add it here.
+  #
+  # Be careful only to use methods and classes that are part of the documented api.
+  # Other methods and classes may change without warning.
+
+  def self.enable
+    return if Obj.respond_to? :obj_extensions_enabled
+
+    Obj.class_eval do
+
+      def self.obj_extensions_enabled
+      end
+
+      # Add custom extensions to the Obj model below
+      #
+
+    end
+
+  end
+end

data/lib/generators/rails_connector/ratings/ratings_generator.rb

@@ -0,0 +1,21 @@
+#:stopdoc:
+require "rails/generators/active_record"
+
+module RailsConnector
+  module Generators
+    class RatingsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      desc "Copy files to your application and create a migration to create ratings."
+      def generate_migration
+        migration_template 'migration.rb', 'db/migrate/create_ratings.rb'
+      end
+    end
+  end
+end

data/lib/generators/rails_connector/ratings/templates/migration.rb

@@ -0,0 +1,15 @@
+# :stopdoc:
+class CreateRatings < ActiveRecord::Migration
+  def self.up
+    create_table :ratings do |t|
+      t.timestamps
+      t.column :obj_id, :string
+      t.column :score, :integer
+      t.column :count, :integer, :default => 0
+    end
+  end
+
+  def self.down
+    drop_table :ratings
+  end
+end

data/lib/infopark_rails_connector.rb

@@ -0,0 +1,31 @@
+module ::RailsConnector
+  def self.load_platform_gem_if_present(name) # :nodoc:
+    if Gem.loaded_specs["infopark_#{name}_connector"]
+      gem_name = "infopark_#{name}_connector"
+
+      # ensure the other connector is present in exactly the same version
+      gem gem_name, Gem.loaded_specs["infopark_rails_connector"].version
+
+      require gem_name
+
+      @platform = name
+    end
+  end
+
+  # return either :fiona or :cloud depending on the app's configuration.
+  def self.platform
+    @platform
+  end
+end
+
+RailsConnector::load_platform_gem_if_present(:cloud)
+RailsConnector::load_platform_gem_if_present(:fiona)
+
+unless RailsConnector::platform
+  raise "The infopark_rails_connector gem requires "\
+    "either the infopark_cloud_connector gem (for use with Infopark Cloud Express) or "\
+    "the infopark_fiona_connector gem (for use with Infopark CMS Fiona). "\
+    "Add either gem to your Gemfile."
+end
+
+require "rails_connector/engine" if defined?(Rails)

data/lib/obj_extensions.rb

@@ -0,0 +1,6 @@
+# empty implementation for ObjExtension
+# only unsed in case the app does not define ObjExtensions itself
+module ObjExtensions
+  def self.enable
+  end
+end

data/lib/rails_connector/authenticable.rb

@@ -0,0 +1,30 @@
+module RailsConnector
+  module Authenticable #:nodoc:
+    def self.included(mod)
+      %w(logged_in? admin? current_user).each do |method_name|
+        unless instance_method_defined?(mod, method_name)
+          mod.class_eval do
+            private
+            define_method(method_name, InstanceMethods.method(method_name).to_proc)
+          end
+        end
+
+        mod.send(:helper_method, method_name)
+      end
+    end
+
+    module InstanceMethods  #:nodoc:
+      def self.logged_in?; false; end
+      def self.admin?; false; end
+      def self.current_user; nil; end
+    end
+
+    private
+
+    def self.instance_method_defined?(mod, method_name)
+      mod.instance_methods.include?(method_name) or
+        mod.protected_instance_methods.include?(method_name) or
+        mod.private_instance_methods.include?(method_name)
+    end
+  end
+end

data/lib/rails_connector/cms_accessible.rb

@@ -0,0 +1,114 @@
+module RailsConnector
+
+  module CmsAccessible
+
+  protected
+
+    def set_preview_time # :nodoc:
+      Obj.preview_time = session[:preview_time]
+    end
+
+    # Filter method to load a CMS object.
+    #
+    # To require the loading for all actions, use this in your controllers:
+    #   before_filter :load_object
+    def load_object # :nodoc:
+      CmsEnv.new(request.env).load
+      loaded_obj = request.env[CmsEnv::OBJ_ENV_KEY]
+      raise loaded_obj if loaded_obj.is_a?(RailsConnector::ResourceNotFound)
+      @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 # :nodoc:
+      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)
+    #
+    # To require the check for all actions, use this in your controllers:
+    #   before_filter :load_object
+    #   before_filter :ensure_object_is_permitted
+    def ensure_object_is_permitted # :nodoc:
+      unless is_permitted(@obj)
+        @obj = nil
+        render_obj_error(403, "forbidden")
+        return false
+      end
+      return true
+    end
+
+    # This method is called when rendering an error caused by either ensure_object_is_permitted
+    # or ensure_object_is_active before filter. It renders an error template located in
+    # "errors/*.html.erb" with given HTTP status and content type "text/html" and with no layout.
+    # Overwrite this method to change the error page.
+    def render_obj_error(status, name)
+      force_html_format
+      render(
+        :template => "errors/#{status}_#{name}",
+        :layout => false,
+        :status => status,
+        :content_type => Mime::HTML
+      )
+    end
+
+    # Enforce "html" as template format.
+    def force_html_format # :doc:
+      request.format = :html
+    end
+
+    # Inclusion hook to make is_permitted available as helper method.
+    def self.included(base) # :nodoc:
+      base.__send__ :helper_method, :is_permitted
+    end
+
+    # Helper method to check live permissions
+    def is_permitted(obj) # :nodoc:
+      obj.permitted_for_user?(current_user)
+    end
+
+    # Filter method which sets the header 'X-Robots-Tag: unavailable_after'
+    # to the valid_until date of the current object.
+    def set_google_expire_header # :nodoc:
+      if @obj && (date = @obj.valid_until)
+        headers['X-Robots-Tag: unavailable_after'] = date.rfc822
+      end
+    end
+
+    # Deliver the obj's body as response by file or data.
+    # May respond with status 304 if a If-Modified-Since header is found.
+    def deliver_file
+      if @obj.body_data_url
+        redirect_to @obj.body_data_url
+      elsif stale?(:last_modified => @obj.last_changed.utc)
+        mime_type = @obj.mime_type
+        mime_type += '; charset=utf-8' if mime_type =~ /^text\//
+
+        if (filepath = @obj.body_data_path).present?
+          send_file(File.expand_path(filepath), {
+            :type => mime_type,
+            :filename => @obj.filename,
+            :disposition => 'inline',
+          })
+        else
+          # generics should send its body, empty files should be delivered as
+          # empty files - and not lead to an application error
+          send_data @obj.body || '', :type => mime_type, :filename => @obj.filename, :disposition => 'inline'
+        end
+      end
+    end
+  end
+end

data/lib/rails_connector/cms_dispatch_controller.rb

@@ -0,0 +1,47 @@
+#:enddoc:
+module RailsConnector
+
+  class CmsDispatchController < ActionController::Metal
+    def process(action)
+      CmsEnv.new(env).load
+      controller = target_controller(env)
+      env["action_dispatch.request.path_parameters"]["controller"] = controller.controller_path
+
+      if !obj_not_found? && action == 'index'
+        action = loaded_obj.controller_action_name
+      end
+
+      env["action_dispatch.request.path_parameters"]["action"] = action
+
+      self.response = controller.action(action).call(env)
+    end
+
+    private
+
+    def target_controller(env)
+      return default_controller if obj_not_found?
+      controller = "#{loaded_obj.controller_name}Controller".constantize
+
+      if controller.respond_to?(:use_for_obj_dispatch?) && controller.use_for_obj_dispatch?
+        controller
+      else
+        default_controller
+      end
+    rescue NameError
+      default_controller
+    end
+
+    def loaded_obj
+      env[CmsEnv::OBJ_ENV_KEY]
+    end
+
+    def obj_not_found?
+      loaded_obj.is_a?(RailsConnector::ResourceNotFound)
+    end
+
+    def default_controller
+      CmsController
+    end
+  end
+
+end

data/lib/rails_connector/cms_env.rb

@@ -0,0 +1,55 @@
+#:enddoc:
+module RailsConnector
+
+  class CmsEnv
+
+    OBJ_ENV_KEY = "INFOPARK_OBJ"
+
+    def initialize(env)
+      @env = env
+    end
+
+    def load
+      return if env[OBJ_ENV_KEY]
+      load_object
+    end
+
+    protected
+
+    attr_reader :env
+
+    def load_object
+      env[OBJ_ENV_KEY] =
+        begin
+          find_obj
+        rescue RailsConnector::ResourceNotFound => e
+          e
+        end
+    end
+
+    def find_obj
+      found_obj =
+        if params[:id]
+          Obj.find(params[:id])
+        elsif params[:permalink].present?
+          permalink =  params[:permalink].to_a.join("/")
+          Obj.find_by_permalink!(permalink)
+        else
+          Obj.homepage
+        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
+
+    def params
+      env["action_dispatch.request.path_parameters"]
+    end
+
+  end
+
+end

data/lib/rails_connector/cms_test_request.rb

@@ -0,0 +1,23 @@
+module RailsConnector
+  module CmsTestRequest # :nodoc:
+    def for_cms_object(test_obj=nil)
+      # prepare the env as if the given obj was loaded by CmsEnv
+      env[RailsConnector::CmsEnv::OBJ_ENV_KEY] = test_obj if test_obj
+      class << self
+        # This special behaviour is necessary for testing controllers that descend from DefaultCmsController.
+        # These controllers do not have explicit routes by default.
+        # Instead, they are reached via the CmsDispatchController.
+        # The TestRequest must therefore use CmsDispatchController as a fallback route.
+        def assign_parameters(routes, controller_path, action, parameters = {})
+          super(routes, controller_path, action, parameters)
+        rescue ActionController::RoutingError=> e
+          begin
+            super(routes, "rails_connector/cms_dispatch", action, parameters)
+          rescue ActionController::RoutingError
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_connector/commentable.rb

@@ -0,0 +1,23 @@
+module RailsConnector
+  # This module is included if the <tt>:comments</tt> addon is
+  # enabled:
+  #     RailsConnector::Configuration.enable(:comments)
+  module Commentable
+    # returns all Comments for this Obj.
+    def comments
+      Comment.where(:obj_id => id).order("created_at")
+    end
+
+    # Returns +true+ by default.
+    # Implement your own conditions by overwriting this method in your +ObjExtensions+.
+    def allow_comments?
+      true
+    end
+
+    # Returns +true+ by default.
+    # Implement your own conditions by overwriting this method in your +ObjExtensions+.
+    def allow_anonymous_comments?
+      true
+    end
+  end
+end

data/lib/rails_connector/configuration/google_analytics.rb

@@ -0,0 +1,29 @@
+module RailsConnector
+  class Configuration
+
+    # This module is an extension to the rails connector configuration.
+    #
+    # Configuration example:
+    #
+    #   RailsConnector::Configuration::GoogleAnalytics.domains(
+    #     'www.example.de' => 'UA-example-1',
+    #     'www.example.com' => 'UA-example-2'
+    #   )
+    module GoogleAnalytics
+      @@domains = {}
+
+      def self.domains=(domains_and_codes)
+        @@domains = @@domains.merge(domains_and_codes)
+      end
+
+      def self.domains(domains_and_codes)
+        self.domains = domains_and_codes
+      end
+
+      def self.domain_code(domain)
+        @@domains[domain]
+      end
+    end
+
+  end
+end

data/lib/rails_connector/configuration/pdf_generator.rb

@@ -0,0 +1,15 @@
+module RailsConnector
+  class Configuration
+    module PdfGenerator
+      @@hosts = []
+
+      def self.host_whitelist(*hosts)
+        @@hosts = hosts
+      end
+
+      def self.host_allowed?(host)
+        @@hosts.include?(host)
+      end
+    end
+  end
+end

data/lib/rails_connector/configuration/rss.rb

@@ -0,0 +1,46 @@
+module RailsConnector
+  class Configuration
+
+    # This module adds configuration options for the RSS feature.
+    #
+    # 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') }
+    module Rss
+
+      # Raised if no RSS root object has been specified.
+      class RootUndefined < StandardError; end
+      # Raised if the root is missing when accessing it
+      # Inherits from RootUndefined for compatibility reasons
+      class RootNotFound < RootUndefined; end
+
+      @root_provider = nil
+
+      # Stores the obj providing lambda for later use
+      def self.root=(obj_provider)
+        case obj_provider
+        when Obj
+          Rails.logger.warn("Rss.root= called with an Obj. Use an Obj returning lambda instead.")
+          root_id = obj_provider.id
+          @root_provider = lambda { Obj.find(root_id) }
+        when Proc
+          @root_provider = obj_provider
+        else
+          raise ArgumentError.new("Rss.root= called with '#{obj_provider.class.name}' instead of a lambda.")
+        end
+      end
+
+      # Returns the RSS root object.
+      # If no RSS root has been specified then Rss::RootUndefined is raised.
+      def self.root
+        raise RootUndefined unless @root_provider
+        begin
+          @root_provider.call
+        rescue RailsConnector::ResourceNotFound
+          raise RootNotFound
+        end
+      end
+    end
+
+  end
+end