Contents

#
# This class provides an abstract for the router interface. Whilst any Proc
# could be used, it's safest for people to sub-class to ensure that any future
# interface changes are catered for.
#
# A router class's responsibility in Penthouse is to receive a Rack::Request
# object from the App instance and return an identifier for that tenant
#

module Penthouse
  module Routers
    class BaseRouter

      # Typically used by the App to return a tenant that can be switched to
      # @param request [Rack::Request] The request from the Rack app, used to determine the tenant
      # @return [String, Symbol] A tenant identifier
      # @raise [Penthouse::TenantNotFound] if the tenant cannot be found/switched to
      def self.call(request)
        raise NotImplementedError
      end

    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
penthouse-0.2.0	lib/penthouse/routers/base_router.rb
penthouse-0.1.0	lib/penthouse/routers/base_router.rb