tennpipes-base 3.6.6

data/lib/tennpipes-base/application.rb

@@ -0,0 +1,175 @@
+require 'tennpipes-base/application/flash'
+require 'tennpipes-base/application/routing'
+require 'tennpipes-base/application/show_exceptions'
+require 'tennpipes-base/application/authenticity_token'
+require 'tennpipes-base/application/application_setup'
+require 'tennpipes-base/application/params_protection'
+
+module Tennpipes
+  ##
+  # Subclasses of this become independent Tennpipes applications
+  # (stemming from Sinatra::Application).
+  # These subclassed applications can be easily mounted into other
+  # Tennpipes applications as well.
+  #
+  class Application < Sinatra::Base
+    register Tennpipes::ApplicationSetup
+    register Tennpipes::Routing
+    register Tennpipes::ParamsProtection
+
+    ##
+    # Returns the logger for this application.
+    #
+    # @return [Tennpipes::Logger] Logger associated with this app.
+    #
+    def logger
+      Tennpipes.logger
+    end
+
+    class << self
+      def inherited(base)
+        begun_at = Time.now
+        CALLERS_TO_IGNORE.concat(TENNPIPES_IGNORE_CALLERS)
+        super(base)
+        base.prerequisites.replace(self.prerequisites.dup)
+        base.default_configuration!
+        logger.devel :setup, begun_at, base
+      end
+
+      ##
+      # Reloads the application files from all defined load paths.
+      #
+      # This method is used from our Tennpipes Reloader during development mode
+      # in order to reload the source files.
+      #
+      # @return [TrueClass]
+      #
+      # @example
+      #   MyApp.reload!
+      #
+      def reload!
+        logger.devel "Reloading application #{settings}"
+        reset!
+        reset_router!
+        Tennpipes.require_dependencies(settings.app_file, :force => true)
+        require_dependencies
+        default_routes
+        default_errors
+        I18n.reload! if defined?(I18n)
+        true
+      end
+
+      ##
+      # Resets application routes to only routes not defined by the user.
+      #
+      # @return [TrueClass]
+      #
+      # @example
+      #   MyApp.reset_routes!
+      #
+      def reset_routes!
+        reset_router!
+        default_routes
+        true
+      end
+
+      ##
+      # Returns the routes of our app.
+      #
+      # @example
+      #   MyApp.routes
+      #
+      def routes
+        router.routes
+      end
+
+      ##
+      # Returns an absolute path of view in application views folder.
+      #
+      # @example
+      #   Admin.view_path 'users/index' #=> "/home/user/test/admin/views/users/index"
+      #
+      def view_path(view)
+        File.expand_path(view, views)
+      end
+
+      ##
+      # Returns an absolute path of application layout.
+      #
+      # @example
+      #   Admin.layout_path :application #=> "/home/user/test/admin/views/layouts/application"
+      #
+      def layout_path(layout)
+        view_path("layouts/#{layout}")
+      end
+
+      ##
+      # Run the Tennpipes app as a self-hosted server using
+      # Thin, Mongrel or WEBrick (in that order).
+      #
+      # @see Tennpipes::Server#start
+      #
+      def run!(options={})
+        return unless Tennpipes.load!
+        Tennpipes.mount(settings.to_s).to('/')
+        Tennpipes.run!(options)
+      end
+
+      ##
+      # Returns default list of path globs to load as dependencies.
+      # Appends custom dependency patterns to the be loaded for your Application.
+      #
+      # @return [Array]
+      #   list of path globs to load as dependencies
+      #
+      # @example
+      #   MyApp.dependencies << "#{Tennpipes.root}/uploaders/**/*.rb"
+      #   MyApp.dependencies << Tennpipes.root('other_app', 'controllers.rb')
+      #
+      def dependencies
+        [
+          'urls.rb',
+          'config/urls.rb',
+          'mailers/*.rb',
+          'mailers.rb',
+          'controllers/**/*.rb',
+          'controllers.rb',
+          'helpers/**/*.rb',
+          'helpers.rb',
+        ].flat_map{ |file| Dir.glob(File.join(settings.root, file)) }
+      end
+
+      ##
+      # An array of file to load before your app.rb, basically are files
+      # which our app depends on.
+      #
+      # By default we look for files:
+      #
+      #   # List of default files that we are looking for:
+      #   yourapp/models.rb
+      #   yourapp/models/**/*.rb
+      #   yourapp/lib.rb
+      #   yourapp/lib/**/*.rb
+      #
+      # @example Adding a custom prerequisite
+      #   MyApp.prerequisites << Tennpipes.root('my_app', 'custom_model.rb')
+      #
+      def prerequisites
+        @_prerequisites ||= []
+      end
+
+      def default(option, *args, &block)
+        set(option, *args, &block) unless respond_to?(option)
+      end
+
+      protected
+
+      ##
+      # Requires all files within the application load paths.
+      #
+      def require_dependencies
+        Tennpipes.require_dependencies(dependencies, :force => true)
+      end
+    end
+  end
+end

data/lib/tennpipes-base/application/application_setup.rb

@@ -0,0 +1,202 @@
+module Tennpipes
+  ##
+  # Holds setup-oriented methods for Tennpipes::Application.
+  #
+  module ApplicationSetup
+    def self.registered(app)
+      app.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      ##
+      # Defines default settings for Tennpipes application.
+      #
+      def default_configuration!
+        set :app_file, File.expand_path(caller_files.first || $0)
+        set :app_name, settings.to_s.underscore.to_sym
+
+        set :environment, Tennpipes.env
+        set :reload, proc { development? }
+        set :logging, proc { development? }
+
+        set :method_override, true
+        set :default_builder, 'StandardFormBuilder'
+
+        default_paths
+        default_security
+        global_configuration
+        setup_prerequisites
+      end
+
+      ##
+      # Setup the application by registering initializers, load paths and logger.
+      # Invoked automatically when an application is first instantiated.
+      #
+      # @return [TrueClass]
+      #
+      def setup_application!
+        return if @_configured
+        require_dependencies
+        default_routes
+        default_errors
+        setup_locale
+        precompile_routes!
+        @_configured = true
+      end
+
+      def precompile_routes?
+        settings.respond_to?(:precompile_routes) && settings.precompile_routes?
+      end
+
+      def precompile_routes!
+        compiled_router.prepare!
+        compiled_router.engine.compile!
+      end
+
+      private
+
+      def default_paths
+        set :locale_path,   proc { Dir.glob File.join(root, 'locale/**/*.{rb,yml}') }
+        set :views,         proc { File.join(root, 'views') }
+
+        set :uri_root,      '/'
+        set :public_folder, proc { Tennpipes.root('public', uri_root) }
+        set :images_path,   proc { File.join(public_folder, 'images') }
+      end
+
+      def default_security
+        set :protection, :except => :path_traversal
+        set :sessions, false
+        set :protect_from_csrf, false
+        set :report_csrf_failure, false
+        set :allow_disabled_csrf, false
+      end
+
+      ##
+      # Applies global tennpipes configuration blocks to current application.
+      #
+      def global_configuration
+        Tennpipes.global_configurations.each do |configuration|
+          class_eval(&configuration)
+        end
+      end
+
+      def setup_prerequisites
+        prerequisites.concat(default_prerequisites).uniq!
+        Tennpipes.require_dependencies(prerequisites)
+      end
+
+      ##
+      # Returns globs of default paths of application prerequisites.
+      #
+      def default_prerequisites
+        [
+          '/models.rb',
+          '/models/**/*.rb',
+          '/lib.rb',
+          '/lib/**/*.rb',
+        ].map{ |glob| File.join(settings.root, glob) }
+      end
+
+      # Overrides the default middleware for Sinatra based on Tennpipes conventions.
+      # Also initializes the application after setting up the middleware.
+      def setup_default_middleware(builder)
+        setup_sessions builder
+        builder.use Sinatra::ExtendedRack           if defined?(EventMachine)
+        builder.use Tennpipes::ShowExceptions         if show_exceptions?
+        builder.use Tennpipes::Logger::Rack, uri_root if Tennpipes.logger && logging?
+        builder.use Tennpipes::Reloader::Rack         if reload?
+        builder.use Rack::MethodOverride            if method_override?
+        builder.use Rack::Head
+        register Tennpipes::Flash
+        setup_protection builder
+        setup_csrf_protection builder
+        setup_application!
+      end
+
+      ##
+      # We need to add almost __sinatra__ images.
+      #
+      def default_routes
+        configure :development do
+          get '*__sinatra__/:image.png' do
+            content_type :png
+            send_file(File.dirname(__FILE__) + "/../images/#{params[:image]}.png")
+          end
+        end
+      end
+
+      ##
+      # This log errors for production environments.
+      #
+      def default_errors
+        configure :production do
+          error ::Exception do
+            logger.exception env['sinatra.error']
+            halt(500, { 'Content-Type' => 'text/html' }, ['<h1>Internal Server Error</h1>'])
+          end unless errors.has_key?(::Exception)
+        end
+      end
+
+      def setup_locale
+        return unless defined? I18n
+        Reloader.special_files += locale_path
+        I18n.load_path << locale_path
+        I18n.reload!
+      end
+
+      # allow custome session management
+      def setup_sessions(builder)
+        if sessions.kind_of?(Hash) && sessions[:use]
+          builder.use sessions[:use], sessions[:config] || {}
+        else
+          super
+        end
+      end
+
+      # sets up csrf protection for the app
+      def setup_csrf_protection(builder)
+        check_csrf_protection_dependency
+
+        if protect_from_csrf?
+          options = options_for_csrf_protection_setup
+          options.merge!(protect_from_csrf) if protect_from_csrf.kind_of?(Hash)
+          builder.use(options[:except] ? Tennpipes::AuthenticityToken : Rack::Protection::AuthenticityToken, options)
+        end
+      end
+
+      # returns the options used in the builder for csrf protection setup
+      def options_for_csrf_protection_setup
+        options = { :logger => logger }
+        if report_csrf_failure? || allow_disabled_csrf?
+          options.merge!(
+            :reaction   => :report,
+            :report_key => 'protection.csrf.failed'
+          )
+        end
+        options
+      end
+
+      # warn if the protect_from_csrf is active but sessions are not
+      def check_csrf_protection_dependency
+        if (protect_from_csrf? && !sessions?) && !defined?(Tennpipes::IGNORE_CSRF_SETUP_WARNING)
+          warn(<<-ERROR)
+  `protect_from_csrf` is activated, but `sessions` seem to be off. To enable csrf
+  protection, use:
+
+      enable :sessions
+
+  or deactivate protect_from_csrf:
+
+      disable :protect_from_csrf
+
+  If you use a different session store, ignore this warning using:
+
+      # in boot.rb:
+      Tennpipes::IGNORE_CSRF_SETUP_WARNING = true
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/tennpipes-base/application/authenticity_token.rb

@@ -0,0 +1,25 @@
+module Tennpipes
+  class AuthenticityToken < Rack::Protection::AuthenticityToken
+    def initialize(app, options = {})
+      @app = app
+      @except = options[:except]
+      @except = Array(@except) unless @except.is_a?(Proc)
+      super
+    end
+
+    def call(env)
+      if except?(env)
+        @app.call(env)
+      else
+        super
+      end
+    end
+
+    def except?(env)
+      return false unless @except
+      path_info = env['PATH_INFO']
+      @except.is_a?(Proc) ? @except.call(env) : @except.any?{|path|
+        path.is_a?(Regexp) ? path.match(path_info) : path == path_info }
+    end
+  end
+end

data/lib/tennpipes-base/application/flash.rb

@@ -0,0 +1,229 @@
+module Tennpipes
+  module Flash
+
+    class << self
+      def registered(app)
+        app.helpers Helpers
+        app.after do
+          session[:_flash] = @_flash.next if @_flash
+        end
+      end
+    end
+
+    class Storage
+      include Enumerable
+
+      # @private
+      def initialize(session=nil)
+        @_now  = session || {}
+        @_next = {}
+      end
+
+      def now
+        @_now
+      end
+
+      def next
+        @_next
+      end
+
+      # @since 0.10.8
+      # @api public
+      def [](type)
+        @_now[type]
+      end
+
+      # @since 0.10.8
+      # @api public
+      def []=(type, message)
+        @_next[type] = message
+      end
+
+      # @since 0.10.8
+      # @api public
+      def delete(type)
+        @_now.delete(type)
+        self
+      end
+
+      # @since 0.10.8
+      # @api public
+      def keys
+        @_now.keys
+      end
+
+      # @since 0.10.8
+      # @api public
+      def key?(type)
+        @_now.key?(type)
+      end
+
+      # @since 0.10.8
+      # @api public
+      def each(&block)
+        @_now.each(&block)
+      end
+
+      # @since 0.10.8
+      # @api public
+      def replace(hash)
+        @_now.replace(hash)
+        self
+      end
+
+      # @since 0.10.8
+      # @api public
+      def update(hash)
+        @_now.update(hash)
+        self
+      end
+      alias_method :merge!, :update
+
+      # @since 0.10.8
+      # @api public
+      def sweep
+        @_now.replace(@_next)
+        @_next = {}
+        self
+      end
+
+      # @since 0.10.8
+      # @api public
+      def keep(key = nil)
+        if key
+          @_next[key] = @_now[key]
+        else
+          @_next.merge!(@_now)
+        end
+        self
+      end
+
+      # @since 0.10.8
+      # @api public
+      def discard(key = nil)
+        if key
+          @_next.delete(key)
+        else
+          @_next = {}
+        end
+        self
+      end
+
+      # @since 0.10.8
+      # @api public
+      def clear
+        @_now.clear
+      end
+
+      # @since 0.10.8
+      # @api public
+      def empty?
+        @_now.empty?
+      end
+
+      # @since 0.10.8
+      # @api public
+      def to_hash
+        @_now.dup
+      end
+
+      def length
+        @_now.length
+      end
+      alias_method :size, :length
+
+      # @since 0.10.8
+      # @api public
+      def to_s
+        @_now.to_s
+      end
+
+      # @since 0.10.8
+      # @api public
+      def error=(message)
+        self[:error] = message
+      end
+
+      # @since 0.10.8
+      # @api public
+      def error
+        self[:error]
+      end
+
+      # @since 0.10.8
+      # @api public
+      def notice=(message)
+        self[:notice] = message
+      end
+
+      # @since 0.10.8
+      # @api public
+      def notice
+        self[:notice]
+      end
+
+      # @since 0.10.8
+      # @api public
+      def success=(message)
+        self[:success] = message
+      end
+
+      # @since 0.10.8
+      # @api public
+      def success
+        self[:success]
+      end
+    end # Storage
+
+    module Helpers
+      ###
+      # Overloads the existing redirect helper in-order to provide support for
+      # flash messages.
+      #
+      # @overload redirect(url)
+      #   @param [String] url
+      #
+      # @overload redirect(url, status_code)
+      #   @param [String] url
+      #   @param [Fixnum] status_code
+      #
+      # @overload redirect(url, status_code, flash_messages)
+      #   @param [String] url
+      #   @param [Fixnum] status_code
+      #   @param [Hash]   flash_messages
+      #
+      # @overload redirect(url, flash_messages)
+      #   @param [String] url
+      #   @param [Hash]   flash_messages
+      #
+      # @example
+      #   redirect(dashboard, success: :user_created)
+      #   redirect(new_location, 301, notice: 'This page has moved. Please update your bookmarks!!')
+      #
+      # @since 0.10.8
+      # @api public
+      def redirect(url, *args)
+        flashes = args.extract_options!
+
+        flashes.each do |type, message|
+          message = I18n.translate(message) if message.is_a?(Symbol) && defined?(I18n)
+          flash[type] = message
+        end
+
+        super(url, args)
+      end
+      alias_method :redirect_to, :redirect
+
+      ###
+      # Returns the flash storage object.
+      #
+      # @return [Storage]
+      #
+      # @since 0.10.8
+      # @api public
+      def flash
+        @_flash ||= Storage.new(env['rack.session'] ? session[:_flash] : {})
+      end
+    end
+  end
+end